version 0.26.2

Fixes #5392

.github/workflows/ci.py

@@ -31,7 +31,11 @@ def install_deps():
     sys.stdout.flush()
     if is_macos:
         items = (x.split()[1].strip('"') for x in open('Brewfile').readlines() if x.strip().startswith('brew '))
-        run('brew', 'install', 'fish', *items)
+        openssl = 'openssl'
+        import ssl
+        if ssl.OPENSSL_VERSION_INFO[0] == 1:
+            openssl += '@1.1'
+        run('brew', 'install', 'fish', openssl, *items)
     else:
         run('sudo apt-get update')
         run('sudo apt-get install -y libgl1-mesa-dev libxi-dev libxrandr-dev libxinerama-dev ca-certificates'
@@ -59,7 +63,7 @@ def build_kitty():
 
 
 def test_kitty():
-    run('./kitty/launcher/kitty +launch test.py')
+    run('./test.py')
 
 
 def package_kitty():

.github/workflows/ci.yml

@@ -20,15 +20,15 @@ jobs:
                 cc: [gcc, clang]
                 include:
                     - python: a
-                      pyver: 3.7
+                      pyver: "3.8"
                       sanitize: 0
 
                     - python: b
-                      pyver: 3.8
+                      pyver: "3.9"
                       sanitize: 1
 
                     - python: c
-                      pyver: 3.9
+                      pyver: "3.10"
                       sanitize: 1
 
 
@@ -42,11 +42,11 @@ jobs:
 
         steps:
             - name: Checkout source code
-              uses: actions/checkout@master
+              uses: actions/checkout@v3
               with:
                 fetch-depth: 10
             - name: Set up Python ${{ matrix.pyver }}
-              uses: actions/setup-python@master
+              uses: actions/setup-python@v3
               with:
                 python-version: ${{ matrix.pyver }}
 
@@ -63,17 +63,17 @@ jobs:
             CFLAGS: -funsigned-char
         steps:
             - name: Checkout source code
-              uses: actions/checkout@master
+              uses: actions/checkout@v3
               with:
-                fetch-depth: 10
+                fetch-depth: 0  # needed for :commit: docs role
 
             - name: Test for trailing whitespace
               run: if grep -Inr '\s$' kitty kitty_tests kittens docs *.py *.asciidoc *.rst .gitattributes .gitignore; then echo Trailing whitespace found, aborting.; exit 1; fi
 
             - name: Set up Python
-              uses: actions/setup-python@master
+              uses: actions/setup-python@v3
               with:
-                python-version: 3.8
+                python-version: 3.9
 
             - name: Install build-only deps
               run: pip install -r docs/requirements.txt flake8 mypy types-requests types-docutils
@@ -84,8 +84,11 @@ jobs:
             - name: Build kitty package
               run: python .github/workflows/ci.py package
 
+            - name: Build kitty
+              run: python setup.py build --debug
+
             - name: Run mypy
-              run: python test.py mypy
+              run: ./test.py mypy
 
             - name: Build man page
               run: make FAIL_WARN=1 man
@@ -120,7 +123,7 @@ jobs:
             - name: Checkout source code
               uses: actions/checkout@master
               with:
-                  fetch-depth: 10
+                  fetch-depth: 0  # needed for :commit: docs role
 
             - name: Build kitty
               run: python3 .github/workflows/ci.py build
@@ -128,5 +131,11 @@ jobs:
             - name: Test kitty
               run: python3 .github/workflows/ci.py test
 
+            - name: Install deps for docs
+              run: python3 -m pip install -r docs/requirements.txt
+
+            - name: Builds docs
+              run: make FAIL_WARN=1 docs
+
             - name: Build kitty package
               run: python3 .github/workflows/ci.py package

.github/workflows/codeql-analysis.yml

@@ -16,7 +16,7 @@ jobs:
 
     steps:
     - name: Checkout repository
-      uses: actions/checkout@v2
+      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.

.gitignore

@@ -2,6 +2,8 @@
 *.pyc
 *.pyo
 *_stub.pyi
+*_generated.go
+*_generated.h
 /.dmypy.json
 /tags
 /build/
@@ -10,7 +12,7 @@
 /compile_commands.json
 /link_commands.json
 /glad/out/
-/kitty/launcher/
+/kitty/launcher/kitty*
 /*.dSYM/
 __pycache__/
 /glfw/wayland-*-client-protocol.[ch]

Makefile

@@ -35,6 +35,12 @@ profile:
 app:
 	python3 setup.py kitty.app $(VVAL)
 
+linux-package: FORCE
+	rm -rf linux-package
+	python3 setup.py linux-package
+
+FORCE:
+
 man:
 	$(MAKE) -C docs man
 

__main__.py

@@ -1,185 +1,7 @@
 #!/usr/bin/env python3
 # License: GPL v3 Copyright: 2015, Kovid Goyal <kovid at kovidgoyal.net>
 
-import os
-import sys
-from typing import List
-
-
-def icat(args: List[str]) -> None:
-    from kittens.runner import run_kitten as rk
-    sys.argv = args
-    rk('icat')
-
-
-def list_fonts(args: List[str]) -> None:
-    from kitty.fonts.list import main as list_main
-    list_main(args)
-
-
-def remote_control(args: List[str]) -> None:
-    from kitty.remote_control import main as rc_main
-    rc_main(args)
-
-
-def runpy(args: List[str]) -> None:
-    if len(args) < 2:
-        raise SystemExit('Usage: kitty +runpy "some python code"')
-    sys.argv = ['kitty'] + args[2:]
-    exec(args[1])
-
-
-def hold(args: List[str]) -> None:
-    import subprocess
-    ret = 1
-    try:
-        ret = subprocess.Popen(args[1:]).wait()
-    except KeyboardInterrupt:
-        pass
-    except FileNotFoundError:
-        print(f'Could not find {args[1]!r} to execute', file=sys.stderr)
-    except Exception as e:
-        print(e, file=sys.stderr)
-    from kitty.utils import hold_till_enter
-    hold_till_enter()
-    raise SystemExit(ret)
-
-
-def complete(args: List[str]) -> None:
-    from kitty.complete import main as complete_main
-    complete_main(args[1:], entry_points, namespaced_entry_points)
-
-
-def open_urls(args: List[str]) -> None:
-    setattr(sys, 'cmdline_args_for_open', True)
-    sys.argv = ['kitty'] + args[1:]
-    from kitty.main import main as kitty_main
-    kitty_main()
-
-
-def launch(args: List[str]) -> None:
-    import runpy
-    sys.argv = args[1:]
-    try:
-        exe = args[1]
-    except IndexError:
-        raise SystemExit(
-            'usage: kitty +launch script.py [arguments to be passed to script.py ...]\n\n'
-            'script.py will be run with full access to kitty code. If script.py is '
-            'prefixed with a : it will be searched for in PATH'
-        )
-    if exe.startswith(':'):
-        import shutil
-        q = shutil.which(exe[1:])
-        if not q:
-            raise SystemExit(f'{exe[1:]} not found in PATH')
-        exe = q
-    if not os.path.exists(exe):
-        raise SystemExit(f'{exe} does not exist')
-    runpy.run_path(exe, run_name='__main__')
-
-
-def shebang(args: List[str]) -> None:
-    script_path = args[1]
-    cmd = args[2:]
-    if cmd == ['__ext__']:
-        cmd = [os.path.splitext(script_path)[1][1:].lower()]
-    try:
-        f = open(script_path)
-    except FileNotFoundError:
-        raise SystemExit(f'The file {script_path} does not exist')
-    with f:
-        if f.read(2) == '#!':
-            line = f.readline().strip()
-            _plat = sys.platform.lower()
-            is_macos: bool = 'darwin' in _plat
-            if is_macos:
-                cmd = line.split(' ')
-            else:
-                cmd = line.split(' ', maxsplit=1)
-    os.execvp(cmd[0], cmd + [script_path])
-
-
-def run_kitten(args: List[str]) -> None:
-    try:
-        kitten = args[1]
-    except IndexError:
-        from kittens.runner import list_kittens
-        list_kittens()
-        raise SystemExit(1)
-    sys.argv = args[1:]
-    from kittens.runner import run_kitten as rk
-    rk(kitten)
-
-
-def edit_config_file(args: List[str]) -> None:
-    from kitty.cli import create_default_opts
-    from kitty.fast_data_types import set_options
-    from kitty.utils import edit_config_file as f
-    set_options(create_default_opts())
-    f()
-
-
-def namespaced(args: List[str]) -> None:
-    try:
-        func = namespaced_entry_points[args[1]]
-    except KeyError:
-        pass
-    else:
-        func(args[1:])
-        return
-    raise SystemExit(f'{args[1]} is not a known entry point. Choices are: ' + ', '.join(namespaced_entry_points))
-
-
-entry_points = {
-    # These two are here for backwards compat
-    'icat': icat,
-    'list-fonts': list_fonts,
-
-    '@': remote_control,
-    '+': namespaced,
-}
-namespaced_entry_points = {k: v for k, v in entry_points.items() if k[0] not in '+@'}
-namespaced_entry_points['hold'] = hold
-namespaced_entry_points['complete'] = complete
-namespaced_entry_points['runpy'] = runpy
-namespaced_entry_points['launch'] = launch
-namespaced_entry_points['open'] = open_urls
-namespaced_entry_points['kitten'] = run_kitten
-namespaced_entry_points['edit-config'] = edit_config_file
-namespaced_entry_points['shebang'] = shebang
-
-
-def setup_openssl_environment() -> None:
-    # Use our bundled CA certificates instead of the system ones, since
-    # many systems come with no certificates in a useable form or have various
-    # locations for the certificates.
-    d = os.path.dirname
-    ext_dir: str = getattr(sys, 'kitty_extensions_dir')
-    if 'darwin' in sys.platform.lower():
-        cert_file = os.path.join(d(d(d(ext_dir))), 'cacert.pem')
-    else:
-        cert_file = os.path.join(d(ext_dir), 'cacert.pem')
-    os.environ['SSL_CERT_FILE'] = cert_file
-    setattr(sys, 'kitty_ssl_env_var', 'SSL_CERT_FILE')
-
-
-def main() -> None:
-    if getattr(sys, 'frozen', False) and getattr(sys, 'kitty_extensions_dir', ''):
-        setup_openssl_environment()
-    first_arg = '' if len(sys.argv) < 2 else sys.argv[1]
-    func = entry_points.get(first_arg)
-    if func is None:
-        if first_arg.startswith('@'):
-            remote_control(['@', first_arg[1:]] + sys.argv[2:])
-        elif first_arg.startswith('+'):
-            namespaced(['+', first_arg[1:]] + sys.argv[2:])
-        else:
-            from kitty.main import main as kitty_main
-            kitty_main()
-    else:
-        func(sys.argv[1:])
-
 
 if __name__ == '__main__':
+    from kitty.entry_points import main
     main()

build-terminfo

@@ -4,7 +4,6 @@
 
 import glob
 import os
-import re
 import shutil
 import subprocess
 import sys
@@ -13,11 +12,10 @@ import tempfile
 
 def compile_terminfo(base):
     with tempfile.TemporaryDirectory() as tdir:
-        proc = subprocess.run(['tic', '-x', f'-o{tdir}', 'terminfo/kitty.terminfo'], check=True, stderr=subprocess.PIPE)
+        proc = subprocess.run(['tic', '-x', f'-o{tdir}', 'terminfo/kitty.terminfo'], capture_output=True)
-        regex = '^"terminfo/kitty.terminfo", line [0-9]+, col [0-9]+, terminal \'xterm-kitty\': older tic versions may treat the description field as an alias$'
+        if proc.returncode != 0:
-        for error in proc.stderr.decode('utf-8').splitlines():
+            sys.stderr.buffer.write(proc.stderr)
-            if not re.match(regex, error):
+            raise SystemExit(proc.returncode)
-                print(error, file=sys.stderr)
         tfiles = glob.glob(os.path.join(tdir, '*', 'xterm-kitty'))
         if not tfiles:
             raise SystemExit('tic failed to output the compiled kitty terminfo file')
@@ -40,6 +38,13 @@ def generate_terminfo():
 
     with open('terminfo/kitty.terminfo', 'w') as f:
         f.write(generate_terminfo())
+    proc = subprocess.run(['tic', '-CrT0', 'terminfo/kitty.terminfo'], capture_output=True)
+    if proc.returncode != 0:
+        sys.stderr.buffer.write(proc.stderr)
+        raise SystemExit(proc.returncode)
+    tcap = proc.stdout.decode('utf-8').splitlines()[-1]
+    with open('terminfo/kitty.termcap', 'w') as f:
+        f.write(tcap)
 
     compile_terminfo(os.path.join(base, 'terminfo'))
 

bypy/linux/__main__.py

@@ -35,6 +35,9 @@ def binary_includes():
             'expat', 'sqlite3', 'ffi', 'z', 'lzma', 'png16', 'lcms2', 'crypt',
             'iconv', 'pcre', 'graphite2', 'glib-2.0', 'freetype', 'rsync',
             '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',
         ))) + (
@@ -140,6 +143,7 @@ def copy_python(env):
         iv['sanitize_source_folder'](os.path.join(env.py_dir, x))
     py_compile(env.py_dir)
     freeze_python(env.py_dir, pdir, env.obj_dir, ext_map, develop_mode_env_var='KITTY_DEVELOP_FROM', remove_pyc_files=True)
+    shutil.rmtree(env.py_dir)
 
 
 def build_launcher(env):

bypy/macos/__main__.py

@@ -369,6 +369,7 @@ class Freeze(object):
             iv['sanitize_source_folder'](join(self.python_stdlib, x))
         self.compile_py_modules()
         freeze_python(self.python_stdlib, pdir, self.obj_dir, ext_map, develop_mode_env_var='KITTY_DEVELOP_FROM', remove_pyc_files=True)
+        shutil.rmtree(self.python_stdlib)
         iv['build_frozen_launcher']([path_to_freeze_dir(), self.obj_dir])
         os.rename(join(dirname(self.contents_dir), 'bin', 'kitty'), join(self.contents_dir, 'MacOS', 'kitty'))
         shutil.rmtree(join(dirname(self.contents_dir), 'bin'))

docs/_templates/base.html

@@ -4,18 +4,14 @@
   {{ super() }}
 
   {%- if analytics_id %}
-      <script type="text/javascript">
+  <!-- Global site tag (gtag.js) - Google Analytics -->
-      var _gaq = _gaq || [];
+    <script async src="https://www.googletagmanager.com/gtag/js?id={{ analytics_id }}"></script>
-      _gaq.push(['_setAccount', '{{ analytics_id }}']);
+    <script>
-      _gaq.push(['_setDomainName', 'none']);
+        window.dataLayer = window.dataLayer || [];
-      _gaq.push(['_setAllowLinker', true]);
+        function gtag(){dataLayer.push(arguments);}
-      _gaq.push(['_trackPageview']);
+        gtag('js', new Date());
 
-      (function() {
+        gtag('config', '{{ analytics_id }}');
-        var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
-        ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
-        var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
-      })();
     </script>
   {% endif -%}
 

docs/basic.rst

@@ -1,12 +1,13 @@
 Tabs and Windows
 -------------------
 
-|kitty| is capable of running multiple programs organized into tabs and
+|kitty| is capable of running multiple programs organized into tabs and windows.
-windows. The top level of organization is the *Tab*. Each tab consists
+The top level of organization is the :term:`OS window <os_window>`. Each OS
-of one or more *windows*. The windows can be arranged in multiple
+window consists of one or more :term:`tabs <tab>`. Each tab consists of one or more
-different layouts, like windows are organized in a tiling window
+:term:`kitty windows <window>`. The kitty windows can be arranged in multiple
-manager. The keyboard controls (which are all customizable) for tabs and
+different :term:`layouts <layout>`, like windows are organized in a tiling
-windows are:
+window manager. The keyboard controls (which are :ref:`all customizable
+<conf-kitty-shortcuts>`) for tabs and windows are:
 
 Scrolling
 ~~~~~~~~~~~~~~
@@ -64,8 +65,9 @@ Focus specific window       :sc:`first_window`, :sc:`second_window` ... :sc:`ten
                             (clockwise from the top-left)
 ========================    =======================
 
-Additionally, you can define shortcuts in :file:`kitty.conf` to focus neighboring
+Additionally, you can define shortcuts in :file:`kitty.conf` to focus
-windows and move windows around (similar to window movement in vim)::
+neighboring windows and move windows around (similar to window movement in
+:program:`vim`)::
 
    map ctrl+left neighboring_window left
    map shift+left move_window right
@@ -77,20 +79,20 @@ You can also define a shortcut to switch to the previously active window::
 
    map ctrl+p nth_window -1
 
-``nth_window`` will focus the nth window for positive numbers (starting from
+:ac:`nth_window` will focus the nth window for positive numbers (starting from
 zero) and the previously active windows for negative numbers.
 
-To switch to the nth OS window, you can define ``nth_os_window``. Only positive
+To switch to the nth OS window, you can define :ac:`nth_os_window`. Only
-numbers are accepted, starting from one.
+positive numbers are accepted, starting from one.
 
 .. _detach_window:
 
-You can define shortcuts to detach the current window and
+You can define shortcuts to detach the current window and move it to another tab
-move it to another tab or another OS window::
+or another OS window::
 
     # moves the window into a new OS window
     map ctrl+f2 detach_window
-    # moves the window into a new Tab
+    # moves the window into a new tab
     map ctrl+f3 detach_window new-tab
     # moves the window into the previously active tab
     map ctrl+f3 detach_window tab-prev
@@ -106,8 +108,8 @@ Similarly, you can detach the current tab, with::
     # asks which OS Window to move the tab into
     map ctrl+f4 detach_tab ask
 
-Finally, you can define a shortcut to close all windows in a tab other than
+Finally, you can define a shortcut to close all windows in a tab other than the
-the currently active window::
+currently active window::
 
     map f9 close_other_windows_in_tab
 
@@ -121,21 +123,22 @@ The full list of actions that can be mapped to key presses is available
 ==================================  =======================
 Action                              Shortcut
 ==================================  =======================
+Show this help                      :sc:`show_kitty_doc`
 Copy to clipboard                   :sc:`copy_to_clipboard` (also :kbd:`⌘+c` on macOS)
 Paste from clipboard                :sc:`paste_from_clipboard` (also :kbd:`⌘+v` on macOS)
 Paste from selection                :sc:`paste_from_selection`
+Pass selection to program           :sc:`pass_selection_to_program`
 Increase font size                  :sc:`increase_font_size` (also :kbd:`⌘++` on macOS)
 Decrease font size                  :sc:`decrease_font_size` (also :kbd:`⌘+-` on macOS)
 Restore font size                   :sc:`reset_font_size` (also :kbd:`⌘+0` on macOS)
 Toggle fullscreen                   :sc:`toggle_fullscreen` (also :kbd:`⌃+⌘+f` on macOS)
 Toggle maximized                    :sc:`toggle_maximized`
-Input unicode character             :sc:`input_unicode_character` (also :kbd:`⌃+⌘+space` on macOS)
+Input Unicode character             :sc:`input_unicode_character` (also :kbd:`⌃+⌘+space` on macOS)
 Open URL in web browser             :sc:`open_url`
 Reset the terminal                  :sc:`reset_terminal` (also :kbd:`⌥+⌘+r` on macOS)
+Edit :file:`kitty.conf`             :sc:`edit_config_file` (also :kbd:`⌘+,` on macOS)
 Reload :file:`kitty.conf`           :sc:`reload_config_file` (also :kbd:`⌃+⌘+,` on macOS)
 Debug :file:`kitty.conf`            :sc:`debug_config` (also :kbd:`⌥+⌘+,` on macOS)
-Pass current selection to program   :sc:`pass_selection_to_program`
-Edit |kitty| config file            :sc:`edit_config_file` (also :kbd:`⌘+,` on macOS)
 Open a |kitty| shell                :sc:`kitty_shell`
 Increase background opacity         :sc:`increase_background_opacity`
 Decrease background opacity         :sc:`decrease_background_opacity`

docs/binary.rst

@@ -4,17 +4,14 @@ Install kitty
 Binary install
 ----------------
 
-.. |ins| replace:: curl -L :literal:`https://sw.kovidgoyal.net/kitty/installer.sh` | sh /dev/stdin
-
 .. highlight:: sh
 
 You can install pre-built binaries of |kitty| if you are on macOS or Linux using
 the following simple command:
 
-.. parsed-literal::
+.. code-block:: sh
-    :class: pre
 
-    |ins|
+    _kitty_install_cmd
 
 
 The binaries will be installed in the standard location for your OS,
@@ -24,7 +21,7 @@ simply re-run the command.
 
 .. warning::
    **Do not** copy the kitty binary out of the installation folder. If you want
-   to add it to your ``PATH`` create a symlink in :file:`~/.local/bin` or
+   to add it to your :envvar:`PATH`, create a symlink in :file:`~/.local/bin` or
    :file:`/usr/bin` or wherever.
 
 
@@ -33,11 +30,12 @@ Manually installing
 
 If something goes wrong or you simply do not want to run the installer, you can
 manually download and install |kitty| from the `GitHub releases page
-<https://github.com/kovidgoyal/kitty/releases>`_. If you are on macOS, download
+<https://github.com/kovidgoyal/kitty/releases>`__. If you are on macOS, download
-the :file:`.dmg` and install as normal. If you are on Linux, download the tarball
+the :file:`.dmg` and install as normal. If you are on Linux, download the
-and extract it into a directory. The |kitty| executable will be in the
+tarball and extract it into a directory. The |kitty| executable will be in the
 :file:`bin` sub-directory.
 
+
 Desktop integration on Linux
 --------------------------------
 
@@ -49,19 +47,30 @@ particular desktop, but it should work for most major desktop environments.
 .. code-block:: sh
 
     # Create a symbolic link to add kitty to PATH (assuming ~/.local/bin is in
-    # your PATH)
+    # your system-wide PATH)
     ln -s ~/.local/kitty.app/bin/kitty ~/.local/bin/
     # Place the kitty.desktop file somewhere it can be found by the OS
     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 path to the kitty icon in the kitty.desktop file(s)
+    # 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::
-    If you use the venerable `stow <https://www.gnu.org/software/stow/>`_
+    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, 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``::
+
+        xdg-mime default org.kde.dolphin.desktop inode/directory
+
+.. note::
+    If you use the venerable `stow <https://www.gnu.org/software/stow/>`__
     command to manage your manual installations, the following takes care of the
-    above for you (use with :file:`dest=~/.local/stow`)::
+    above for you (use with :code:`dest=~/.local/stow`)::
 
         cd ~/.local/stow
         stow -v kitty.app
@@ -74,44 +83,39 @@ Customizing the installation
 
 * You can install the latest nightly kitty build with ``installer``:
 
-  .. parsed-literal::
+  .. code-block:: sh
-     :class: pre
 
-     |ins| \\
+     _kitty_install_cmd \\
          installer=nightly
 
   If you want to install it in parallel to the released kitty specify a
   different install locations with ``dest``:
 
-  .. parsed-literal::
+  .. code-block:: sh
-     :class: pre
 
-     |ins| \\
+     _kitty_install_cmd \\
          installer=nightly dest=/some/other/location
 
 * You can specify a different install location, with ``dest``:
 
-  .. parsed-literal::
+  .. code-block:: sh
-     :class: pre
 
-     |ins| \\
+     _kitty_install_cmd \\
          dest=/some/other/location
 
 * You can tell the installer not to launch |kitty| after installing it with
   ``launch=n``:
 
-  .. parsed-literal::
+  .. code-block:: sh
-     :class: pre
 
-     |ins| \\
+     _kitty_install_cmd \\
          launch=n
 
 * You can use a previously downloaded dmg/tarball, with ``installer``:
 
-  .. parsed-literal::
+  .. code-block:: sh
-     :class: pre
 
-     |ins| \\
+     _kitty_install_cmd \\
          installer=/path/to/dmg or tarball
 
 

docs/build.rst

@@ -7,21 +7,21 @@ Build from source
 
 .. highlight:: sh
 
-|kitty| is designed to run from source, for easy hack-ability. Make sure
+|kitty| is designed to run from source, for easy hack-ability. Make sure the
-the following dependencies are installed first.
+following dependencies are installed first.
 
 .. note::
-   If you just want to test the latest changes to kitty you dont need to build
+   If you just want to test the latest changes to kitty, you don't need to build
    from source. Instead install the :ref:`latest nightly build <nightly>`.
 
 .. note::
-   If you are making small changes only to the python parts of kitty, there is no need to
+   If you are making small changes only to the Python parts of kitty, there is
-   build kitty at all, instead, assuming you have installed the official kitty
+   no need to build kitty at all, instead, assuming you have installed the
-   binaries, you can simply set the KITTY_DEVELOP_FROM enviroment variable to
+   official kitty binaries, you can simply set the :envvar:`KITTY_DEVELOP_FROM`
-   point to the directory into which you have checked out the kitty source
+   enviroment variable to point to the directory into which you have checked out
-   code. kitty will then load its python code from there. You should use a
+   the kitty source code. kitty will then load its Python code from there. You
-   version of the source that matches the binary version as closely as
+   should use a version of the source that matches the binary version as closely
-   possible, since the two are tightly coupled.
+   as possible, since the two are tightly coupled.
 
 
 Dependencies
@@ -29,12 +29,13 @@ Dependencies
 
 Run-time dependencies:
 
-* ``python`` >= 3.6
+* ``python`` >= 3.8
 * ``harfbuzz`` >= 2.2.0
 * ``zlib``
 * ``libpng``
 * ``liblcms2``
 * ``librsync``
+* ``openssl``
 * ``freetype`` (not needed on macOS)
 * ``fontconfig`` (not needed on macOS)
 * ``libcanberra`` (not needed on macOS)
@@ -46,7 +47,9 @@ Build-time dependencies:
 
 * ``gcc`` or ``clang``
 * ``pkg-config``
-* For building on Linux in addition to the above dependencies you might also need to install the following packages, if they are not already installed by your distro:
+* For building on Linux in addition to the above dependencies you might also
+  need to install the following packages, if they are not already installed by
+  your distro:
 
   - ``libdbus-1-dev``
   - ``libxcursor-dev``
@@ -77,9 +80,12 @@ You can run |kitty|, as::
 
     ./kitty/launcher/kitty
 
-If that works, you can create a symlink to the launcher in :file:`~/bin` or
+If that works, you can create a symlink to the launcher in :file:`~/bin` or some
-some other directory on your PATH so that you can run |kitty| using
+other directory on your PATH so that you can run |kitty| using just ``kitty``.
-just ``kitty``.
+
+To have the kitty documentation available locally, run::
+
+    python3 -m pip install -r docs/requirements.txt && make docs
 
 
 Building kitty.app on macOS from source
@@ -87,28 +93,30 @@ Building kitty.app on macOS from source
 
 Run::
 
+    python3 -m pip install -r docs/requirements.txt && make docs
     make app
 
+Building the docs needs to be done only once.
+
 This :file:`kitty.app` unlike the released one does not include its own copy of
-python and the other dependencies. So if you ever un-install/upgrade those dependencies
+Python and the other dependencies. So if you ever un-install/upgrade those
-you might have to rebuild the app.
+dependencies you might have to rebuild the app.
 
 .. note::
    The released :file:`kitty.dmg` includes all dependencies, unlike the
    :file:`kitty.app` built above and is built automatically by using the
-   `bypy framework <https://github.com/kovidgoyal/bypy>`_ however, that is
+   `bypy framework <https://github.com/kovidgoyal/bypy>`__ however, that is
    designed to run on Linux and is not for the faint of heart.
 
 .. note::
-   Apple disallows certain functionality, such as notifications for unsigned applications.
+   Apple disallows certain functionality, such as notifications for unsigned
-   If you need this functionality, you can try signing the built kitty.app with
+   applications. If you need this functionality, you can try signing the built
-   a self signed certificate, see for example, `here
+   :file:`kitty.app` with a self signed certificate, see for example, `here
-   <https://stackoverflow.com/questions/27474751/how-can-i-codesign-an-app-without-being-in-the-mac-developer-program/27474942>`_.
+   <https://stackoverflow.com/questions/27474751/how-can-i-codesign-an-app-without-being-in-the-mac-developer-program/27474942>`__.
 
 .. note::
-   If you are facing issues with ``linker`` while building,
+   If you are facing issues with ``linker`` while building, try with a ``brew``
-   try with a ``brew`` installed python instead, see :iss:`289`
+   installed Python instead, see :iss:`289` for more discussion.
-   for more discussion.
 
 
 Build and run from source with Nix
@@ -116,87 +124,78 @@ Build and run from source with Nix
 
 On NixOS or any other Linux or macOS system with the Nix package manager
 installed, execute `nix-shell
-<https://nixos.org/guides/nix-pills/developing-with-nix-shell.html>`_ to create
+<https://nixos.org/guides/nix-pills/developing-with-nix-shell.html>`__ to create
 the correct environment to build kitty or use ``nix-shell --pure`` instead to
 eliminate most of the influence of the outside system, e.g. globally installed
 packages. ``nix-shell`` will automatically fetch all required dependencies and
 make them available in the newly spawned shell.
 
-Then proceed with ``make`` or ``make app`` according to the platform specific instructions above.
+Then proceed with ``make`` or ``make app`` according to the platform specific
+instructions above.
 
 
+Debug builds
+--------------
+
+A basic debug build can be done with::
+
+    make debug
+
+This includes debug info in the binary for better traces. To build with address
+sanitizer, use::
+
+    make asan
+
+Which will result in a debug binary that uses the address sanitizer as well.
+
 .. _packagers:
 
 Notes for Linux/macOS packagers
 ----------------------------------
 
 The released |kitty| source code is available as a `tarball`_ from
-`the GitHub releases page <https://github.com/kovidgoyal/kitty/releases>`_.
+`the GitHub releases page <https://github.com/kovidgoyal/kitty/releases>`__.
 
-While |kitty| does use python, it is not a traditional python package, so please
+While |kitty| does use Python, it is not a traditional Python package, so please
 do not install it in site-packages.
 Instead run::
 
     python3 setup.py linux-package
 
-This will install |kitty| into the directory :file:`linux-package`. You can run |kitty|
+This will install |kitty| into the directory :file:`linux-package`. You can run
-with :file:`linux-package/bin/kitty`.  All the files needed to run kitty will be in
+|kitty| with :file:`linux-package/bin/kitty`. All the files needed to run kitty
-:file:`linux-package/lib/kitty`. The terminfo file will be installed into
+will be in :file:`linux-package/lib/kitty`. The terminfo file will be installed
-:file:`linux-package/share/terminfo`. Simply copy these files into :file:`/usr` to install
+into :file:`linux-package/share/terminfo`. Simply copy these files into
-|kitty|. In other words, :file:`linux-package` is the staging area into which |kitty| is
+:file:`/usr` to install |kitty|. In other words, :file:`linux-package` is the
-installed. You can choose a different staging area, by passing the ``--prefix``
+staging area into which |kitty| is installed. You can choose a different staging
-argument to :file:`setup.py`.
+area, by passing the ``--prefix`` argument to :file:`setup.py`.
 
 You should probably split |kitty| into three packages:
 
 :code:`kitty-terminfo`
-    installs the terminfo file
+    Installs the terminfo file
 
 :code:`kitty-shell-integration`
-    installs the shell integration scripts (the contents of the
+    Installs the shell integration scripts (the contents of the
-    shell-integration directory in the kitty source code, probably to
+    shell-integration directory in the kitty source code), probably to
     :file:`/usr/share/kitty/shell-integration`
 
 :code:`kitty`
-    installs the main program
+    Installs the main program
 
 This allows users to install the terminfo and shell integration files on
-servers into which they ssh, without needing to install all of |kitty|.
+servers into which they ssh, without needing to install all of |kitty|. The
+shell integration files **must** still be present in
+:file:`lib/kitty/shell-integration` when installing the kitty main package as
+the kitty program expects to find them there.
 
 .. note::
-   You need a couple of extra dependencies to build linux-package.
+   You need a couple of extra dependencies to build linux-package. :file:`tic`
-   :file:`tic` to compile terminfo files, usually found in the
+   to compile terminfo files, usually found in the development package of
-   development package of :file:`ncurses`. Also, if you are building from
+   :file:`ncurses`. Also, if you are building from a git checkout instead of the
-   a git checkout instead of the released source code tarball, you will
+   released source code tarball, you will need to install the dependencies from
-   need to install the dependencies from ``docs/requirements.txt`` to
+   :file:`docs/requirements.txt` to build the kitty documentation. They can be
-   build the kitty documentation. They can be installed most easily with
+   installed most easily with ``python -m pip -r docs/requirements.txt``.
-   ``python -m pip -r docs/requirements.txt``.
 
 This applies to creating packages for |kitty| for macOS package managers such as
 Homebrew or MacPorts as well.
-
-
-Changing defaults for packages
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-|kitty| has its defaults chosen to be suitable for a standalone distributable.
-If you are packaging it a few of these might need to be changed.
-
-update-checking
-   |kitty| has its own update check mechanism, if you would like to turn
-   it off for your package, use::
-
-       ./setup.py linux-package --update-check-interval=0
-
-shell-integration
-   |kitty| by default injects its :ref:`shell_integration` code into the user's
-   shell using environment variables. For a package, it might make more sense
-   to distribute the shell integration scripts into the system-wide shell
-   vendor locations. The shell integration files are found in the
-   :file:`shell-integration` directory. Copy them to the system wide shell
-   vendor locations for each shell, and use::
-
-       ./setup.py linux-package --shell-integration=enabled\ no-rc
-
-   This will prevent kitty from modifying the user's shell environment to load
-   the integration scripts.

docs/changelog.rst

@@ -9,23 +9,15 @@ To update |kitty|, :doc:`follow the instructions <binary>`.
 Recent major new features
 ---------------------------
 
-.. only:: dirhtml
+Truly convenient SSH
+~~~~~~~~~~~~~~~~~~~~~~~~
 
-   A demo video
+The :doc:`ssh kitten <kittens/ssh>` is redesigned with powerful new features:
-   ~~~~~~~~~~~~~~~~
 
-   A new video showcasing some of kitty's many productivity enhancing features.
+* Automatic :ref:`shell_integration` on remote machines
-
+* Easily :ref:`clone local shell/editor config <real_world_ssh_kitten_config>` on remote machines
-   .. raw:: html
+* Easily :ref:`edit files in your local editor <edit_file>` on remote machines
-
+* Automatic :opt:`re-use of existing connections <kitten-ssh.share_connections>` to avoid connection setup latency
-        <video controls width="640" height="360" poster="../_static/poster.png">
-            <source src="https://download.calibre-ebook.com/videos/kitty.mp4" type="video/mp4">
-            <source src="https://download.calibre-ebook.com/videos/kitty.webm" type="video/webm">
-        </video>
-
-   .. rst-class:: caption caption-text
-
-       Watch kitty in action!
 
 
 Shell integration
@@ -38,43 +30,255 @@ scrollback by pressing :sc:`scroll_to_previous_prompt` and clicking with the
 mouse anywhere in the current command to move the cursor there. See
 :doc:`shell-integration` for details.
 
-Logos for windows
-~~~~~~~~~~~~~~~~~~~~
-
-kitty has the ability to display arbitrary ``PNG`` images at the corner
-of any kitty window to serve as a *logo* for quick window identification.
-Can be controlled via :opt:`window_logo_path` and also and changed via
-the :ref:`at_set-window-logo` remote control command.
-Useful to quickly identify special windows or just for some *bling*.
-
-.. figure:: screenshots/window-logo.png
-    :alt: A screenshot of the kitty shell window showing the kitty logo
-    :align: center
-    :width: 100%
-
-    A screenshot of the kitty shell window showing the kitty logo
-
-
-Visual keyboard based window select
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-Select a kitty window visually using the keyboard, like the
-:doc:`kittens/hints`, but for kitty windows. Can also be used from shell
-scripts/third party integrations via the :ref:`at_select-window` remote control
-command.
-
-.. figure:: screenshots/select-window.png
-    :alt: A screenshot of the kitty select window function
-    :align: center
-    :width: 100%
-
-    Hints for selecting kitty windows visually
-
 .. }}}
 
 Detailed list of changes
 -------------------------------------
 
+0.26.2 [2022-09-05]
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+- Allow creating :code:`overlay-main` windows, which are treated as the active window unlike normal overlays (:iss:`5392`)
+
+- hints kitten: Allow using :doc:`launch` as the program to run, to open the result in a new kitty tab/window/etc. (:iss:`5462`)
+
+- hyperlinked_grep kitten: Allow control over which parts of ``rg`` output are hyperlinked (:pull:`5428`)
+
+- Fix regression in 0.26.0 that caused launching kitty without working STDIO handles to result in high CPU usage and prewarming failing (:iss:`5444`)
+
+- :doc:`/launch`: Allow setting the margin and padding for newly created windows (:iss:`5463`)
+
+- macOS: Fix regression in 0.26.0 that caused asking the user for a line of input such as for :ac:`set_tab_title` to not work (:iss:`5447`)
+
+- hints kitten: hyperlink matching: Fix hints occasionally matching text on subsequent line as part of hyperlink (:pull:`5450`)
+
+- Fix a regression in 0.26.0 that broke mapping of native keys whose key codes did not fit in 21 bits (:iss:`5452`)
+
+- Wayland: Fix remembering window size not accurate when client side decorations are present
+
+- Fix an issue where notification identifiers were not sanitized leading to
+  code execution if the user clicked on a notification popup from a malicious
+  source. Thanks to Carter Sande for discovering this vulnerability.
+
+0.26.1 [2022-08-30]
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+- ssh kitten: Fix executable permission missing from kitty bootstrap script (:iss:`5438`)
+
+- Fix a regression in 0.26.0 that caused kitty to no longer set the ``LANG`` environment variable on macOS (:iss:`5439`)
+
+- Allow specifying a title when using the :ac:`set_tab_title` action (:iss:`5441`)
+
+0.26.0 [2022-08-29]
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+- A new option :opt:`remote_control_password` to use fine grained permissions for what can be remote controlled (:disc:`5320`)
+
+- Reduce startup latency by ~30 milliseconds when running kittens via key bindings inside kitty (:iss:`5159`)
+
+- A new option :opt:`modify_font` to adjust various font metrics like underlines, cell sizes etc. (:pull:`5265`)
+
+- A new shortcut :sc:`show_kitty_doc` to display the kitty docs in a browser
+
+- Graphics protocol: Only delete temp files if they have the string
+  :code:`tty-graphics-protocol` in their file paths. This prevents deletion of arbitrary files in :file:`/tmp`.
+
+- Deprecate the ``adjust_baseline``, ``adjust_line_height`` and ``adjust_column_width`` options in favor of :opt:`modify_font`
+
+- Wayland: Fix a regression in the previous release that caused mouse cursor
+  animation and keyboard repeat to stop working when switching seats (:iss:`5188`)
+
+- Allow resizing windows created in session files (:pull:`5196`)
+
+- Fix horizontal wheel events not being reported to client programs when they grab the mouse (:iss:`2819`)
+
+- macOS: Remote control: Fix unable to launch a new OS window or background process when there is no OS window (:iss:`5210`)
+
+- macOS: Fix unable to open new tab or new window when there is no OS window (:iss:`5276`)
+
+- kitty @ set-colors: Fix changing inactive_tab_foreground not working (:iss:`5214`)
+
+- macOS: Fix a regression that caused switching keyboard input using Eisu and
+  Kana keys not working (:iss:`5232`)
+
+- Add a mappable action to toggle the mirrored setting for the tall and fat
+  layouts (:pull:`5344`)
+
+- Add a mappable action to switch between predefined bias values for the tall and fat
+  layouts (:pull:`5352`)
+
+- Wayland: Reduce flicker at startup by not using render frames immediately after a resize (:iss:`5235`)
+
+- Linux: Update cursor position after all key presses not just pre-edit text
+  changes (:iss:`5241`)
+
+- ssh kitten: Allow ssh kitten to work from inside tmux, provided the tmux
+  session inherits the correct KITTY env vars (:iss:`5227`)
+
+- ssh kitten: A new option :code:`--symlink-strategy` to control how symlinks
+  are copied to the remote machine (:iss:`5249`)
+
+- ssh kitten: Allow pressing :kbd:`Ctrl+C` to abort ssh before the connection is
+  completed (:iss:`5271`)
+
+- Bash integration: Fix declare not creating global variables in .bashrc (:iss:`5254`)
+
+- Bash integration: Fix the inherit_errexit option being set by shell integration (:iss:`5349`)
+
+- :command:`kitty @ scroll-window` allow scrolling by fractions of a screen
+  (:iss:`5294`)
+
+- remote files kitten: Fix working with files whose names have characters that
+  need to be quoted in shell scripts (:iss:`5313`)
+
+- Expand ~ in paths configured in :opt:`editor` and :opt:`exe_search_path` (:disc:`5298`)
+
+- Allow showing the working directory of the active window in tab titles
+  (:pull:`5314`)
+
+- ssh kitten: Allow completion of ssh options between the destination and command (:iss:`5322`)
+
+- macOS: Fix speaking selected text not working (:iss:`5357`)
+
+- Allow ignoring failure to close windows/tabs via rc commands (:disc:`5406`)
+
+- Fix hyperlinks not present when fetching text from the history buffer
+  (:iss:`5427`)
+
+
+0.25.2 [2022-06-07]
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+- A new command :command:`edit-in-kitty` to :ref:`edit_file`
+
+- Allow getting the last non-empty command output easily via an action or
+  remote control (:pull:`4973`)
+
+- Fix a bug that caused :opt:`macos_colorspace` to always be ``default`` regardless of its actual value (:iss:`5129`)
+
+- diff kitten: A new option :opt:`kitten-diff.ignore_name` to exclude files and directories from being scanned (:pull:`5171`)
+
+- ssh kitten: Fix bash not being executed as a login shell since kitty 0.25.0 (:iss:`5130`)
+
+- macOS: When pasting text and the clipboard has a filesystem path, paste the
+  full path instead of the text, which is sometimes just the file name (:pull:`5142`)
+
+- macOS: Allow opening executables without a file extension with kitty as well
+  (:iss:`5160`)
+
+- Themes kitten: Add a tab to show user defined custom color themes separately
+  (:pull:`5150`)
+
+- Iosevka: Fix incorrect rendering when there is a combining char that does not
+  group with its neighbors (:iss:`5153`)
+
+- Weston: Fix client side decorations flickering on slow computers during
+  window resize (:iss:`5162`)
+
+- Remote control: Fix commands with large or asynchronous payloads like
+  :command:`kitty @ set-backround-image`, :command:`kitty @ set-window-logo`
+  and :command:`kitty @ select-window` not working correctly
+  when using a socket (:iss:`5165`)
+
+- hints kitten: Fix surrounding quotes/brackets and embedded carriage returns
+  not being removed when using line number processing (:iss:`5170`)
+
+
+0.25.1 [2022-05-26]
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+- Shell integration: Add a command to :ref:`clone_shell`
+
+- Remote control: Allow using :ref:`Boolean operators <search_syntax>` when constructing queries to match windows or tabs
+
+- Sessions: Fix :code:`os_window_size` and :code:`os_window_class` not applying to the first OS Window (:iss:`4957`)
+
+- Allow using the cwd of the oldest as well as the newest foreground process for :option:`launch --cwd` (:disc:`4869`)
+
+- Bash integration: Fix the value of :opt:`shell_integration` not taking effect if the integration script is sourced in bashrc (:pull:`4964`)
+
+- Fix a regression in the previous release that caused mouse move events to be incorrectly reported as drag events even when a button is not pressed (:iss:`4992`)
+
+- remote file kitten: Integrate with the ssh kitten for improved performance
+  and robustness. Re-uses the control master connection of the ssh kitten to
+  avoid round-trip latency.
+
+- Fix tab selection when closing a new tab not correct in some scenarios (:iss:`4987`)
+
+- A new action :ac:`open_url` to open the specified URL (:pull:`5004`)
+
+- A new option :opt:`select_by_word_characters_forward` that allows changing
+  which characters are considered part of a word to the right when double clicking to select
+  words (:pull:`5103`)
+
+- macOS: Make the global menu shortcut to open kitty website configurable (:pull:`5004`)
+
+- macOS: Add the :opt:`macos_colorspace` option to control what color space colors are rendered in (:iss:`4686`)
+
+- Fix reloading of config not working when :file:`kitty.conf` does not exist when kitty is launched (:iss:`5071`)
+
+- Fix deleting images by row not calculating image bounds correctly (:iss:`5081`)
+
+- Increase the max number of combining chars per cell from two to three, without increasing memory usage.
+
+- Linux: Load libfontconfig at runtime to allow the binaries to work for
+  running kittens on servers without FontConfig
+
+- GNOME: Fix for high CPU usage caused by GNOME's text input subsystem going
+  into an infinite loop when IME cursor position is updated after a done event
+  (:iss:`5105`)
+
+
+0.25.0 [2022-04-11]
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+- :doc:`kittens/ssh`: automatic shell integration when using SSH. Easily
+  clone local shell and editor configuration on remote machines, and automatic
+  re-use of existing connections to avoid connection setup latency.
+
+- When pasting URLs at shell prompts automatically quote them. Also allow filtering pasted text and confirm pastes. See :opt:`paste_actions` for details. (:iss:`4873`)
+
+- Change the default value of :opt:`confirm_os_window_close` to ask for confirmation when closing windows that are not sitting at shell prompts
+
+- A new value :code:`last_reported` for :option:`launch --cwd` to use the current working directory last reported by the program running in the terminal
+
+- macOS: When using Apple's less as the pager for viewing scrollback strip out OSC codes as it cant parse them (:iss:`4788`)
+
+- diff kitten: Fix incorrect rendering in rare circumstances when scrolling after changing the context size (:iss:`4831`)
+
+- icat kitten: Fix a regression that broke :option:`kitty +kitten icat --print-window-size` (:pull:`4818`)
+
+- Wayland: Fix :opt:`hide_window_decorations` causing docked windows to be resized on blur (:iss:`4797`)
+
+- Bash integration: Prevent shell integration code from running twice if user enables both automatic and manual integration
+
+- Bash integration: Handle existing PROMPT_COMMAND ending with a literal newline
+
+- Fix continued lines not having their continued status reset on line feed (:iss:`4837`)
+
+- macOS: Allow the New kitty Tab/Window Here services to open multiple selected folders.  (:pull:`4848`)
+
+- Wayland: Fix a regression that broke IME when changing windows/tabs (:iss:`4853`)
+
+- macOS: Fix Unicode paths not decoded correctly when dropping files (:pull:`4879`)
+
+- Avoid flicker when starting kittens such as the hints kitten (:iss:`4674`)
+
+- A new action :ac:`scroll_prompt_to_top` to move the current prompt to the top (:pull:`4891`)
+
+- :ac:`select_tab`: Use stable numbers when selecting the tab (:iss:`4792`)
+
+- Only check for updates in the official binary builds. Distro packages or source builds will no longer check for updates, regardless of the
+  value of :opt:`update_check_interval`.
+
+- Fix :opt:`inactive_text_alpha` still being applied to the cursor hidden window after focus (:iss:`4928`)
+
+- Fix resizing window that is extra tall/wide because of left-over cells not
+  working reliably (:iss:`4913`)
+
+- A new action :ac:`close_other_tabs_in_os_window` to close other tabs in the active OS window (:pull:`4944`)
+
+
 0.24.4 [2022-03-03]
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
@@ -594,7 +798,7 @@ Detailed list of changes
 0.21.2 [2021-06-28]
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-- A new :opt:`adjust_baseline` option to adjust the vertical alignment of text
+- A new ``adjust_baseline`` option to adjust the vertical alignment of text
   inside a line (:pull:`3734`)
 
 - A new :opt:`url_excluded_characters` option to exclude additional characters
@@ -768,7 +972,7 @@ Detailed list of changes
   scrollback buffer onto the screen. Useful, for example, to restore
   the screen after showing completions below the shell prompt.
 
-- A new remote control command :ref:`at_env` to change the default
+- A new remote control command :ref:`at-env` to change the default
   environment passed to newly created windows (:iss:`3529`)
 
 - Linux: Fix binary kitty builds not able to load fonts in WOFF2 format
@@ -793,7 +997,7 @@ Detailed list of changes
   kitty window title bar
 
 - Fix reading :option:`kitty --session` from ``STDIN`` not working when the
-  :option:`kitty --detach` option is used (:iss:`3523`)
+  :code:`kitty --detach` option is used (:iss:`3523`)
 
 - Special case rendering of the few remaining Powerline box drawing chars
   (:iss:`3535`)
@@ -1936,7 +2140,7 @@ Detailed list of changes
 - Allow the user to control the resize debounce time via
   :opt:`resize_debounce_time`.
 
-- Remote control: Make the :ref:`at_set-font-size` command more capable.
+- Remote control: Make the :ref:`at-set-font-size` command more capable.
   It can now increment font size and reset it. It also only acts on the
   active top-level window, by default (:iss:`1581`)
 
@@ -2245,7 +2449,7 @@ Detailed list of changes
 
 - Fix a regression in 0.12.0 that broke dynamic resizing of layouts (:iss:`860`)
 
-- Wayland: Allow using the :option:`kitty --class` command line flag
+- Wayland: Allow using the :code:`kitty --class` command line flag
   to set the app id (:iss:`862`)
 
 - Add completion of the kitty command for the fish shell (:pull:`829`)
@@ -2288,7 +2492,7 @@ Detailed list of changes
   window is not the active window (:iss:`729`)
 
 - Remote control: Allow changing the current window layout with a new
-  :ref:`at_goto-layout` command (:iss:`845`)
+  :ref:`at-goto-layout` command (:iss:`845`)
 
 - Remote control: Allow matching windows by the environment variables of their
   child process as well

docs/color-stack.rst

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

docs/conf.py

@@ -13,7 +13,7 @@ import subprocess
 import sys
 import time
 from functools import partial
-from typing import Any, Callable, Dict, Iterable, List, Optional, Tuple
+from typing import Any, Callable, Dict, Iterable, List, Tuple
 
 from docutils import nodes
 from docutils.parsers.rst.roles import set_classes
@@ -85,7 +85,7 @@ master_doc = 'index'
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
-language: Optional[str] = None
+language: str = 'en'
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
@@ -104,6 +104,10 @@ rst_prolog = '''
 '''.replace('VERSION', str_version)
 smartquotes_action = 'qe'  # educate quotes and ellipses but not dashes
 
+string_replacements = {
+    '_kitty_install_cmd': 'curl -L https://sw.kovidgoyal.net/kitty/installer.sh | sh /dev/stdin',
+}
+
 
 # -- Options for HTML output -------------------------------------------------
 
@@ -116,10 +120,23 @@ html_title = 'kitty'
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
 # documentation.
-#
+github_icon_path = 'M8 0C3.58 0 0 3.58 0 8c0 3.54 2.29 6.53 5.47 7.59.4.07.55-.17.55-.38 0-.19-.01-.82-.01-1.49-2.01.37-2.53-.49-2.69-.94-.09-.23-.48-.94-.82-1.13-.28-.15-.68-.52-.01-.53.63-.01 1.08.58 1.23.82.72 1.21 1.87.87 2.33.66.07-.52.28-.87.51-1.07-1.78-.2-3.64-.89-3.64-3.95 0-.87.31-1.59.82-2.15-.08-.2-.36-1.02.08-2.12 0 0 .67-.21 2.2.82.64-.18 1.32-.27 2-.27.68 0 1.36.09 2 .27 1.53-1.04 2.2-.82 2.2-.82.44 1.1.16 1.92.08 2.12.51.56.82 1.27.82 2.15 0 3.07-1.87 3.75-3.65 3.95.29.25.54.73.54 1.48 0 1.07-.01 1.93-.01 2.2 0 .21.15.46.55.38A8.013 8.013 0 0 0 16 8c0-4.42-3.58-8-8-8z'  # noqa
+
 html_theme_options: Dict[str, Any] = {
     'sidebar_hide_name': True,
     'navigation_with_keys': True,
+    'footer_icons': [
+        {
+            "name": "GitHub",
+            "url": "https://github.com/kovidgoyal/kitty",
+            "html": f"""
+                <svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 16 16">
+                    <path fill-rule="evenodd" d="{github_icon_path}"></path>
+                </svg>
+            """,
+            "class": "",
+        },
+    ],
 }
 
 
@@ -200,6 +217,13 @@ def commit_role(
 def write_cli_docs(all_kitten_names: Iterable[str]) -> None:
     from kitty.cli import option_spec_as_rst
     from kitty.launch import options_spec as launch_options_spec
+    from kittens.ssh.copy import option_text
+    from kittens.ssh.options.definition import copy_message
+    with open('generated/ssh-copy.rst', 'w') as f:
+        f.write(option_spec_as_rst(
+            appname='copy', ospec=option_text, heading_char='^',
+            usage='file-or-dir-to-copy ...', message=copy_message
+        ))
     with open('generated/launch.rst', 'w') as f:
         f.write(option_spec_as_rst(
             appname='launch', ospec=launch_options_spec, heading_char='_',
@@ -225,7 +249,7 @@ if you specify a program-to-run you can use the special placeholder
         from kitty.rc.base import cli_params_for
         for cmd_name in sorted(all_command_names()):
             func = command_for_name(cmd_name)
-            p(f'.. _at_{func.name}:\n')
+            p(f'.. _at-{func.name}:\n')
             p('kitty @', func.name)
             p('-' * 120)
             p('.. program::', 'kitty @', func.name)
@@ -253,7 +277,7 @@ 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*([a-zA-Z0-9_+]+)\s*:\s*(.+)')
+    field_pat = re.compile(r'\s*([a-zA-Z0-9_+/]+)\s*:\s*(.+)')
 
     def format_cmd(p: Callable[..., None], name: str, cmd: RemoteCommand) -> None:
         p(name)
@@ -265,7 +289,7 @@ def write_remote_control_protocol_docs() -> None:  # {{{
             if m is None:
                 p(line)
             else:
-                fields.append((m.group(1), m.group(2)))
+                fields.append((m.group(1).split('/')[0], m.group(2)))
         if fields:
             p('\nFields are:\n')
             for (name, desc) in fields:
@@ -293,8 +317,16 @@ 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 app.config.string_replacements.items():
+        src = src.replace(k, v)
+    source[0] = src
+# }}}
+
 # config file docs {{{
 
+
 class ConfLexer(RegexLexer):  # type: ignore
     name = 'Conf'
     aliases = ['conf']
@@ -509,6 +541,8 @@ def setup(app: Any) -> None:
     write_cli_docs(kn)
     write_remote_control_protocol_docs()
     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)
     app.add_lexer('session', SessionLexer() if version_info[0] < 3 else SessionLexer)

docs/conf.rst

@@ -3,13 +3,14 @@ kitty.conf
 
 .. highlight:: conf
 
-|kitty| is highly customizable, everything from keyboard shortcuts, to
+|kitty| is highly customizable, everything from keyboard shortcuts, to rendering
-rendering frames-per-second. See below for an overview of all customization
+frames-per-second. See below for an overview of all customization possibilities.
-possibilities.
 
-You can open the config file within kitty by pressing :sc:`edit_config_file` (:kbd:`⌘+,` on macOS).
+You can open the config file within kitty by pressing :sc:`edit_config_file`
-You can reload the config file within kitty by pressing
+(:kbd:`⌘+,` on macOS). A :file:`kitty.conf` with commented default
-:sc:`reload_config_file` (:kbd:`⌃+⌘+,` on macOS) or sending kitty the ``SIGUSR1`` signal.
+configurations and descriptions will be created if the file does not exist.
+You can reload the config file within kitty by pressing :sc:`reload_config_file`
+(:kbd:`⌃+⌘+,` on macOS) or sending kitty the ``SIGUSR1`` signal.
 You can also display the current configuration by pressing :sc:`debug_config`
 (:kbd:`⌥+⌘+,` on macOS).
 
@@ -17,26 +18,32 @@ You can also display the current configuration by pressing :sc:`debug_config`
 
 |kitty| looks for a config file in the OS config directories (usually
 :file:`~/.config/kitty/kitty.conf`) but you can pass a specific path via the
-:option:`kitty --config` option or use the ``KITTY_CONFIG_DIRECTORY``
+:option:`kitty --config` option or use the :envvar:`KITTY_CONFIG_DIRECTORY`
-environment variable. See the :option:`kitty --config` option for full details.
+environment variable. See :option:`kitty --config` for full details.
 
 Comments can be added to the config file as lines starting with the ``#``
-character. This works only if the ``#`` character is the first character
+character. This works only if the ``#`` character is the first character in the
-in the line.
+line.
+
+.. _include:
 
 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
 :code:`USER=name`. Also, you can use :code:`globinclude` to include files
-matching a shell glob pattern. For example::
+matching a shell glob pattern and :code:`envinclude` to include configuration
+from environment variables. For example::
 
      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_*
 
 
 .. note:: Syntax highlighting for :file:`kitty.conf` in vim is available via
-   `vim-kitty <https://github.com/fladson/vim-kitty>`_.
+   `vim-kitty <https://github.com/fladson/vim-kitty>`__.
 
 
 .. include:: /generated/conf-kitty.rst
@@ -47,17 +54,17 @@ Sample kitty.conf
 
 .. only:: html
 
-    You can download a sample :file:`kitty.conf` file with all default settings and
+    You can download a sample :file:`kitty.conf` file with all default settings
-    comments describing each setting by clicking: :download:`sample kitty.conf
+    and comments describing each setting by clicking: :download:`sample
-    </generated/conf/kitty.conf>`.
+    kitty.conf </generated/conf/kitty.conf>`.
 
 .. only:: man
 
    You can edit a fully commented sample kitty.conf by pressing the
-   :sc:`edit_config_file` shortcut in kitty. This will generate a config
+   :sc:`edit_config_file` shortcut in kitty. This will generate a config file
-   file with full documentation and all settings commented out. If you
+   with full documentation and all settings commented out. If you have a
-   have a pre-existing kitty.conf, then that will be used instead, delete
+   pre-existing :file:`kitty.conf`, then that will be used instead, delete it to
-   it to see the sample file.
+   see the sample file.
 
 
 All mappable actions

docs/deccara.rst

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

docs/desktop-notifications.rst

@@ -5,21 +5,20 @@ Desktop notifications
 =======================
 
 |kitty| implements an extensible escape code (OSC 99) to show desktop
-notifications. It is easy to use from shell scripts and fully extensible to
+notifications. It is easy to use from shell scripts and fully extensible to show
-show title and body.  Clicking on the notification can optionally focus the
+title and body. Clicking on the notification can optionally focus the window it
-window it came from, and/or send an escape code back to the application running
+came from, and/or send an escape code back to the application running in that
-in that window.
+window.
 
-The design of the escape code is partially based on the discussion in
+The design of the escape code is partially based on the discussion in the
-the defunct
+defunct `terminal-wg <https://gitlab.freedesktop.org/terminal-wg/specifications/-/issues/13>`__
-`terminal-wg <https://gitlab.freedesktop.org/terminal-wg/specifications/-/issues/13>`_
 
 The escape code has the form::
 
     <OSC> 99 ; metadata ; payload <terminator>
 
 Here ``<OSC>`` is :code:`<ESC>]` and ``<terminator>`` is
-:code:`<ESC><backslash>`.  The metadata is a section of colon separated
+:code:`<ESC><backslash>`. The ``metadata`` is a section of colon separated
 :code:`key=value` pairs. Every key must be a single character from the set
 :code:`a-zA-Z` and every value must be a word consisting of characters from
 the set :code:`a-zA-Z0-9-_/\+.,(){}[]*&^%$#@!`~`. The payload must be
@@ -45,28 +44,27 @@ The design of the escape code is fundamentally chunked, this is because
 different terminal emulators have different limits on how large a single escape
 code can be. Chunking is accomplished by the ``i`` and ``d`` keys. The ``i``
 key is the *notification id* which can be any string containing the characters
-``[a-zA-Z0-9_-+.]``. The ``d`` key stands for *done* and
+``[a-zA-Z0-9_-+.]``. The ``d`` key stands for *done* and can only take the
-can only take the values ``0`` and ``1``. A value of ``0`` means the
+values ``0`` and ``1``. A value of ``0`` means the notification is not yet done
-notification is not yet done and the terminal emulator should hold off
+and the terminal emulator should hold off displaying it. A value of ``1`` means
-displaying it. A value of ``1`` means the notification is done, and should be
+the notification is done, and should be displayed. You can specify the title or
-displayed. You can specify the title or body multiple times and the terminal
+body multiple times and the terminal emulator will concatenate them, thereby
-emulator will concatenate them, thereby allowing arbitrarily long text
+allowing arbitrarily long text (terminal emulators are free to impose a sensible
-(terminal emulators are free to impose a sensible limit to avoid
+limit to avoid Denial-of-Service attacks).
-Denial-of-Service attacks).
 
 Both the ``title`` and ``body`` payloads must be either UTF-8 encoded plain
-text with no embedded escape codes, or UTF-8 text that is base64 encoded, in
+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.
+is Base64 encoded.
 
 When the user clicks the notification, a couple of things can happen, the
 terminal emulator can focus the window from which the notification came, and/or
 it can send back an escape code to the application indicating the notification
-was activated. This is controlled by the ``a`` key which takes a comma
+was activated. This is controlled by the ``a`` key which takes a comma separated
-separated set of values, ``report`` and ``focus``. The value ``focus`` means
+set of values, ``report`` and ``focus``. The value ``focus`` means focus the
-focus the window from which the notification was issued and is the default.
+window from which the notification was issued and is the default. ``report``
-``report`` means send an escape code back to the application. The format of the
+means send an escape code back to the application. The format of the returned
-returned escape code is::
+escape code is::
 
     <OSC> 99 ; i=identifier ; <terminator>
 
@@ -87,9 +85,9 @@ to display it based on what it does understand.
 
 .. note::
    It is possible to extend this escape code to allow specifying an icon for
-   the notification, however, given that some platforms, such as macOS, dont
+   the notification, however, given that some platforms, such as legacy versions
-   allow displaying custom icons on a notification, at all, it was decided to
+   of macOS, don't allow displaying custom images on a notification, it was
-   leave it out of the spec for the time being.
+   decided to leave it out of the spec for the time being.
 
    Similarly, features such as scheduled notifications could be added in future
    revisions.
@@ -107,7 +105,7 @@ Key      Value                 Default    Description
 ``d``    ``0`` or ``1``        ``1``      Indicates if the notification is
                                           complete or not.
 
-``e``    ``0`` or ``1``        ``0``      If set to ``1`` means the payload is base64 encoded UTF-8,
+``e``    ``0`` or ``1``        ``0``      If set to ``1`` means the payload is Base64 encoded UTF-8,
                                           otherwise it is plain UTF-8 text with no C0 control codes in it
 
 ``i``    ``[a-zA-Z0-9-_+.]``   ``0``      Identifier for the notification
@@ -118,5 +116,6 @@ Key      Value                 Default    Description
 
 
 .. note::
-   |kitty| also supports the legacy OSC 9 protocol developed by iTerm2 for
+   |kitty| also supports the `legacy OSC 9 protocol developed by iTerm2
-   desktop notifications.
+   <https://iterm2.com/documentation-escape-codes.html>`__ for desktop
+   notifications.

docs/extract-rst-targets.py

@@ -0,0 +1,54 @@
+#!/usr/bin/env python
+# License: GPLv3 Copyright: 2022, Kovid Goyal <kovid at kovidgoyal.net>
+
+import os
+import re
+from typing import Dict, Iterator
+
+tgt_pat = re.compile(r'^.. _(\S+?):$', re.MULTILINE)
+title_pat = re.compile('^(.+)\n[-=^#*]{5,}$', re.MULTILINE)
+
+
+def find_explicit_targets(text: str) -> Iterator[str]:
+    for m in tgt_pat.finditer(text):
+        yield m.group(1)
+
+
+def find_page_title(text: str) -> str:
+    for m in title_pat.finditer(text):
+        return m.group(1)
+    return ''
+
+
+def main() -> Dict[str, Dict[str, str]]:
+    refs = {}
+    docs = {}
+    base = os.path.dirname(os.path.abspath(__file__))
+    for dirpath, dirnames, filenames in os.walk(base):
+        if 'generated' in dirnames:
+            dirnames.remove('generated')
+        for f in filenames:
+            if f.endswith('.rst'):
+                with open(os.path.join(dirpath, f)) as stream:
+                    raw = stream.read()
+                href = os.path.relpath(stream.name, base).replace(os.sep, '/')
+                href = href.rpartition('.')[0] + '/'
+                docs[href.rstrip('/')] = find_page_title(raw)
+                first_line = raw.lstrip('\n').partition('\n')[0]
+                first_target_added = False
+                for explicit_target in find_explicit_targets(raw):
+                    # Shorten the reference link to the top of the page.
+                    # Note that anchor links should still be used in HTML docs
+                    # to allow jumping within the same page.
+                    if not first_target_added:
+                        first_target_added = True
+                        if first_line.startswith(f'.. _{explicit_target}:'):
+                            refs[explicit_target] = href
+                            continue
+                    refs[explicit_target] = href + f'#{explicit_target.replace("_", "-")}'
+    return {'ref': refs, 'doc': docs}
+
+
+if __name__ == '__main__':
+    import json
+    print(json.dumps(main(), indent=2))

docs/faq.rst

@@ -27,14 +27,15 @@ turned off for specific symbols using :opt:`narrow_symbols`.
 Using a color theme with a background color does not work well in vim?
 -----------------------------------------------------------------------
 
-First make sure you have not changed the TERM environment variable, it should
+First make sure you have not changed the :envvar:`TERM` environment variable, it
-be ``xterm-kitty``. vim uses *background color erase* even if the terminfo file
+should be ``xterm-kitty``. vim uses *background color erase* even if the
-does not contain the ``bce`` capability. This is a bug in vim. You can work around
+terminfo file does not contain the ``bce`` capability. This is a bug in vim. You
-it by adding the following to your vimrc::
+can work around it by adding the following to your vimrc::
 
     let &t_ut=''
 
-See :doc:`here <deccara>` for why |kitty| does not support background color erase.
+See :doc:`here <deccara>` for why |kitty| does not support background color
+erase.
 
 
 I get errors about the terminal being unknown or opening the terminal failing when SSHing into a different computer?
@@ -46,42 +47,33 @@ terminfo files to the server::
 
     kitty +kitten ssh myserver
 
-This ssh kitten takes all the same command line arguments
+This :doc:`ssh kitten <kittens/ssh>` takes all the same command line arguments
-as ssh, you can alias it to ssh in your shell's rc files to avoid having to
+as :program:`ssh`, you can alias it to something small in your shell's rc files
-type it each time::
+to avoid having to type it each time::
 
-    alias ssh="kitty +kitten ssh"
+    alias s="kitty +kitten ssh"
 
-Remember to also setup :ref:`shell_integration` for completion and other
+If the ssh kitten fails, use the following one-liner instead (it is slower as it
-niceties.
+needs to ssh into the server twice, but will work with most servers)::
-
-If for some reason that does not work (typically because the server is using a
-non POSIX compliant shell as ``/bin/sh``), you can try using it with ``python``
-instead::
-
-    kitty +kitten ssh use-python myserver
-
-If that also fails, perhaps because python is not installed on the remote
-server, use the following one-liner instead (it
-is slower as it needs to ssh into the server twice, but will work with most
-servers)::
 
     infocmp -a xterm-kitty | ssh myserver tic -x -o \~/.terminfo /dev/stdin
 
-If you are behind a proxy (like Balabit) that prevents this, you must redirect the
+If you are behind a proxy (like Balabit) that prevents this, or :program:`tic`
-1st command to a file, copy that to the server and run ``tic`` manually.  If you
+comes with macOS that does not support reading from STDIN, you must redirect the
-connect to a server, embedded or Android system that doesn't have ``tic``, copy over
+first command to a file, copy that to the server and run :program:`tic`
-your local file terminfo to the other system as :file:`~/.terminfo/x/xterm-kitty`.
+manually. If you connect to a server, embedded or Android system that doesn't
+have :program:`tic`, copy over your local file terminfo to the other system as
+:file:`~/.terminfo/x/xterm-kitty`.
 
 Really, the correct solution for this is to convince the OpenSSH maintainers to
-have ssh do this automatically, if possible, when connecting to a server, so that
+have :program:`ssh` do this automatically, if possible, when connecting to a
-all terminals work transparently.
+server, so that all terminals work transparently.
 
 If the server is running FreeBSD, or another system that relies on termcap
 rather than terminfo, you will need to convert the terminfo file on your local
 machine by running (on local machine with |kitty|)::
 
-    infocmp -C xterm-kitty
+    infocmp -CrT0 xterm-kitty
 
 The output of this command is the termcap description, which should be appended
 to :file:`/usr/share/misc/termcap` on the remote server. Then run the following
@@ -93,22 +85,29 @@ command to apply your change (on the server)::
 Keys such as arrow keys, backspace, delete, home/end, etc. do not work when using su or sudo?
 -------------------------------------------------------------------------------------------------
 
-Make sure the TERM environment variable, is ``xterm-kitty``.  And either the
+Make sure the :envvar:`TERM` environment variable, is ``xterm-kitty``.  And
-TERMINFO environment variable points to a directory containing :file:`x/xterm-kitty`
+either the :envvar:`TERMINFO` environment variable points to a directory
-or that file is under :file:`~/.terminfo/x/`.
+containing :file:`x/xterm-kitty` or that file is under :file:`~/.terminfo/x/`.
 
-Note that ``sudo`` might remove TERMINFO.  Then setting it at the shell prompt can
+For macOS, you may also need to put that file under :file:`~/.terminfo/78/`::
-be too late, because command line editing may not be reinitialized.  In that case
+
-you can either ask ``sudo`` to set it or if that is not supported, insert an ``env``
+    mkdir -p ~/.terminfo/{78,x}
-command before starting the shell, or, if not possible, after sudo start another
+    ln -snf ../x/xterm-kitty ~/.terminfo/78/xterm-kitty
-Shell providing the right terminfo path::
+    tic -x -o ~/.terminfo "$KITTY_INSTALLATION_DIR/terminfo/kitty.terminfo"
+
+Note that :program:`sudo` might remove :envvar:`TERMINFO`. Then setting it at
+the shell prompt can be too late, because command line editing may not be
+reinitialized. In that case you can either ask :program:`sudo` to set it or if
+that is not supported, insert an :program:`env` command before starting the
+shell, or, if not possible, after sudo start another shell providing the right
+terminfo path::
 
     sudo … TERMINFO=$HOME/.terminfo bash -i
     sudo … env TERMINFO=$HOME/.terminfo bash -i
     TERMINFO=/home/ORIGINALUSER/.terminfo exec bash -i
 
-You can configure sudo to preserve TERMINFO by running ``sudo
+You can configure :program:`sudo` to preserve :envvar:`TERMINFO` by running
-visudo`` and adding the following line::
+``sudo visudo`` and adding the following line::
 
     Defaults env_keep += "TERM TERMINFO"
 
@@ -132,12 +131,15 @@ 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`.
+Or you can enable :doc:`remote control <remote-control>` for |kitty| and use
-The shortcut mapping technique has the same syntax as the remote control
+:ref:`at-set-colors`. The shortcut mapping technique has the same syntax as the
-command, for details, see :ref:`at_set-colors`.
+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>`_
+`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:
@@ -154,7 +156,7 @@ to set colors. Examples of using OSC escape codes to set colors::
     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>`_
+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
@@ -167,14 +169,15 @@ 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``.
+from the GUI, i.e. by clicking the |kitty| application icon or using
-Note that this file is *only read* when running via the GUI.
+``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:
+You can, of course, also run |kitty| from a terminal with command line options,
-:file:`/Applications/kitty.app/Contents/MacOS/kitty`.
+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`.
 
-And within |kitty| itself, you can always run |kitty| using just `kitty` as it
-cleverly adds itself to the ``PATH``.
 
 I catted a binary file and now kitty is hung?
 -----------------------------------------------
@@ -182,10 +185,10 @@ 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
+are control codes. Some of these control codes are of arbitrary length, so if
-if the binary data you output into the terminal happens to contain the starting
+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
+sequence for one of these control codes, the terminal will hang waiting for the
-the closing sequence. Press :kbd:`ctrl+shift+delete` to reset the terminal.
+closing sequence. Press :sc:`reset_terminal` to reset the terminal.
 
 If you do want to cat unknown data, use ``cat -v``.
 
@@ -193,30 +196,34 @@ 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
+|kitty| achieves its stellar performance by caching alpha masks of each rendered
-rendered character on the GPU, and rendering them all in parallel. This means
+character on the GPU, and rendering them all in parallel. This means it is a
-it is a strictly character cell based display. As such it can use only
+strictly character cell based display. As such it can use only monospace fonts,
-monospace fonts, since every cell in the grid has to be the same size.
+since every cell in the grid has to be the same size. Furthermore, it needs
-Furthermore, it needs fonts to be freely resizable, so it does not support
+fonts to be freely resizable, so it does not support bitmapped fonts.
-bitmapped fonts.
 
 .. note::
-   If you are trying to use a font patched with NERD font symbols, dont do that
+   If you are trying to use a font patched with `Nerd Fonts
-   as patching destroys fonts. There is no need, simply install the standalone
+   <https://nerdfonts.com/>`__ symbols, don't do that as patching destroys
-   NERD font (the file :file:`NerdFontsSymbolsOnly.zip` from the `NERD font
+   fonts. There is no need, simply install the standalone ``Symbols Nerd Font``
-   releases page <https://github.com/ryanoasis/nerd-fonts/releases>`__). kitty
+   (the file :file:`NerdFontsSymbolsOnly.zip` from the `Nerd Fonts releases page
-   should pick up symbols from it automatically, and you can tell it to do so
+   <https://github.com/ryanoasis/nerd-fonts/releases>`__). kitty should pick up
-   explicitly in case it doesnt with the :opt:`symbol_map` directive::
+   symbols from it automatically, and you can tell it to do so explicitly in
+   case it doesn't with the :opt:`symbol_map` directive::
 
         symbol_map U+23FB-U+23FE,U+2665,U+26A1,U+2B58,U+E000-U+E00A,U+E0A0-U+E0A3,U+E0B0-U+E0C8,U+E0CA,U+E0CC-U+E0D2,U+E0D4,U+E200-U+E2A9,U+E300-U+E3E3,U+E5FA-U+E62F,U+E700-U+E7C5,U+F000-U+F2E0,U+F300-U+F31C,U+F400-U+F4A9,U+F500-U+F8FF Symbols Nerd Font
 
+   Those Unicode symbols beyond the ``E000-F8FF`` Unicode private use area 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::
+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
+Note that the spacing property is calculated by fontconfig based on actual glyph
-glyph widths in the font. If for some reason fontconfig concludes your favorite
+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`::
 
@@ -276,9 +283,13 @@ homepage:
    :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
+
 On macOS you can change the icon by following the steps:
 
-#. Find :file:`kitty.app` in the Applications folder, select it and press :kbd:`⌘+i`
+#. 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::
 
@@ -298,7 +309,14 @@ the :sc:`send_text <send_text>` you can use the ``show_key`` kitten. Run::
 
     kitty +kitten show_key
 
-Then press the key you want to emulate.
+Then press the key you want to emulate. Note that this kitten will only show
+keys that actually reach the terminal program, in particular, keys mapped to
+actions in kitty will not be shown. To check those first map them to
+:ac:`no_op`. You can also start a kitty instance without any shortcuts to
+interfere::
+
+    kitty -o clear_all_shortcuts=yes kitty +kitten show_key
+
 
 How do I open a new window or tab with the same working directory as the current window?
 --------------------------------------------------------------------------------------------
@@ -325,8 +343,8 @@ 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 ``LANG, LC_*`` and loading of configuration
+related to localization, such as :envvar:`LANG`, ``LC_*`` and loading of
-files such as ``XDG_*, KITTY_CONFIG_DIRECTORY``.
+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`::
@@ -343,40 +361,42 @@ 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
+First, terminal multiplexers are :iss:`a bad idea <391#issuecomment-638320745>`,
-not use them, if at all possible. kitty contains features that do all of what
+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.
 
 Image display will not work, see `tmux issue
-<https://github.com/tmux/tmux/issues/1391>`_.
+<https://github.com/tmux/tmux/issues/1391>`__.
 
-Using ancient versions of tmux such as 1.8 will
+Using ancient versions of tmux such as 1.8 will cause gibberish on screen when
-cause gibberish on screen when pressing keys (:iss:`3541`).
+pressing keys (:iss:`3541`).
 
-If you are using tmux with multiple terminals or you start it under one
+If you are using tmux with multiple terminals or you start it under one terminal
-terminal and then switch to another and these terminals have different TERM
+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
+variables, tmux will break. You will need to restart it as tmux does not support
-support multiple terminfo definitions.
+multiple terminfo definitions.
 
 If you use any of the advanced features that kitty has innovated, such as
-styled underlines, desktop notifications, extended keyboard support, etc.
+:doc:`styled underlines </underlines>`, :doc:`desktop notifications
-they may or may not work, depending on the whims of tmux's maintainer, your
+</desktop-notifications>`, :doc:`extended keyboard support
-version of tmux, etc.
+</keyboard-protocol>`, 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?
 -------------------------------------------------------------------------------------------
 
-``top`` is not a good way to measure process memory usage. That is because on
+:program:`top` is not a good way to measure process memory usage. That is
-modern systems, when allocating memory to a process, the C library functions
+because on modern systems, when allocating memory to a process, the C library
-will typically allocate memory in large blocks, and give the process chunks of
+functions will typically allocate memory in large blocks, and give the process
-these blocks. When the process frees a chunk, the C library will not
+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, ``top`` will still claim the process is
+application has released the memory, :program:`top` will still claim the process
-using it.
+is using it.
 
-To check for memory leaks, instead use a tool like ``valgrind``. Run::
+To check for memory leaks, instead use a tool like `Valgrind
+<https://valgrind.org/>`__. Run::
 
     PYTHONMALLOC=malloc valgrind --tool=massif kitty
 
@@ -389,18 +409,19 @@ that window, maybe run yes or find again. Then quit kitty and run::
 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 ``valgrind`` as you get
+For those interested, you can get a similar profile out of :program:`valgrind`
-with ``top`` by adding ``--pages-as-heap=yes`` then you will see that memory
+as you get with :program:`top` by adding ``--pages-as-heap=yes`` then you will
-allocated in malloc is not freed in free. This can be further refined if you
+see that memory allocated in malloc is not freed in free. This can be further
-use `glibc`` as your C library by setting the environment variable
+refined if you use ``glibc`` as your C library by setting the environment
-``MALLOC_MMAP_THRESHOLD_=64``. This will cause free to actually free memory
+variable ``MALLOC_MMAP_THRESHOLD_=64``. This will cause free to actually free
-allocated in sizes of more than 64 bytes. With this set, memory usage will
+memory allocated in sizes of more than 64 bytes. With this set, memory usage
-climb high, then fall when closing windows, but not fall all the way back. The
+will climb high, then fall when closing windows, but not fall all the way back.
-remaining used memory can be investigated using valgrind again, and it will
+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 dont release it back
+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?
 -------------------------------------------------------------------------------------------
 
@@ -424,4 +445,4 @@ The correct command will depend on your situation and hardware.
 :file:`libEGL_mesa.so` and ignore :file:`libEGL_nvidia.so` also available on the
 system, which will wake the NVIDIA card during device enumeration.
 ``MESA_LOADER_DRIVER_OVERRIDE`` also assures that Mesa won't offer any NVIDIA
-card during enumeration, and will instead just use `/lib/dri/radeonsi_dri.so`.
+card during enumeration, and will instead just use :file:`radeonsi_dri.so`.

docs/glossary.rst

@@ -30,14 +30,20 @@ Glossary
    overlay
       An *overlay window* is a :term:`kitty window <window>` that is placed on
       top of an existing kitty window, entirely covering it. Overlays are used
-      throught kitty, for example, to display the :ref:`the scrollback buffer <scrollback>`,
+      throughout kitty, for example, to display the :ref:`the scrollback buffer <scrollback>`,
       to display :doc:`hints </kittens/hints>`, for :doc:`unicode input
-      </kittens/unicode_input>` etc.
+      </kittens/unicode_input>` etc. Normal overlays are meant for short
+      duration popups and so are not considered the :italic:`active window`
+      when determining the current working directory or getting input text for
+      kittens, launch commands, etc. To create an overlay considered as a
+      :italic:`main window` use the :code:`overlay-main` argument to
+      :doc:`launch`.
 
    hyperlinks
       Terminals can have hyperlinks, just like the internet. In kitty you can
       :doc:`control exactly what happens <open_actions>` when clicking on a
-      hyperlink, based on the type of link and its URL.
+      hyperlink, based on the type of link and its URL. See also `Hyperlinks in terminal
+      emulators <https://gist.github.com/egmontkob/eb114294efbcd5adb1944c9f3cb5feda>`__.
 
 .. _env_vars:
 
@@ -45,6 +51,7 @@ Environment variables
 ------------------------
 
 Variables that influence kitty behavior
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 .. envvar:: KITTY_CONFIG_DIRECTORY
 
@@ -57,11 +64,17 @@ Variables that influence kitty behavior
    Controls where kitty stores cache files. Defaults to :file:`~/.cache/kitty`
    or :file:`~/Library/Caches/kitty` on macOS.
 
+.. envvar:: KITTY_RUNTIME_DIRECTORY
+
+   Controls where kitty stores runtime files like sockets. Defaults to
+   the :code:`XDG_RUNTIME_DIR` environment variable if that is defined
+   otherwise the run directory inside the kitty cache directory is used.
+
 .. envvar:: VISUAL
 
-   The terminal editor (such as ``vi`` or ``nano``) kitty uses, when, for
+   The terminal based text editor (such as :program:`vi` or :program:`nano`)
-   instance, opening :file:`kitty.conf` in response to :sc:`edit_config_file`.
+   kitty uses, when, for instance, opening :file:`kitty.conf` in response to
-
+   :sc:`edit_config_file`.
 
 .. envvar:: EDITOR
 
@@ -78,84 +91,124 @@ Variables that influence kitty behavior
    is possible for the autodiscovery to fail; the default Wayland XKB mappings
    are used in this case. See :pull:`3943` for details.
 
+.. envvar:: SSH_ASKPASS
+
+   Specify the program for SSH to ask for passwords. When this is set, :doc:`ssh
+   kitten </kittens/ssh>` will use this environment variable by default. See
+   :opt:`askpass <kitten-ssh.askpass>` for details.
+
+.. envvar:: KITTY_CLONE_SOURCE_CODE
+
+   Set this to some shell code that will be executed in the cloned window with
+   :code:`eval` when :ref:`clone-in-kitty <clone_shell>` is used.
+
+.. envvar:: KITTY_CLONE_SOURCE_PATH
+
+   Set this to the path of a file that will be sourced in the cloned window when
+   :ref:`clone-in-kitty <clone_shell>` is used.
+
+.. envvar:: KITTY_DEVELOP_FROM
+
+   Set this to the directory path of the kitty source code and its Python code
+   will be loaded from there. Only works with official binary builds.
+
+.. envvar:: KITTY_RC_PASSWORD
+
+   Set this to a pass phrase to use the ``kitty @`` remote control command with
+   :opt:`remote_control_password`.
+
 
 Variables that kitty sets when running child programs
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 .. envvar:: LANG
 
-   This is set only on macOS, and only if the country and language from the
+   This is only set on macOS. If the country and language from the macOS user
-   macOS user settings form a valid locale.
+   settings form an invalid locale, it will be set to :code:`en_US.UTF-8`.
 
+.. envvar:: PATH
+
+   kitty prepends itself to the PATH of its own environment to ensure the
+   functions calling :program:`kitty` will work properly.
 
 .. envvar:: KITTY_WINDOW_ID
 
    An integer that is the id for the kitty :term:`window` the program is running in.
    Can be used with the :doc:`kitty remote control facility <remote-control>`.
 
-
 .. envvar:: KITTY_PID
 
    An integer that is the process id for the kitty process in which the program
    is running. Allows programs to tell kitty to reload its config by sending it
    the SIGUSR1 signal.
 
+.. envvar:: KITTY_PUBLIC_KEY
+
+   A public key that programs can use to communicate securely with kitty using
+   the remote control protocol. The format is: :code:`protocol:key data`.
 
 .. envvar:: WINDOWID
 
    The id for the :term:`OS Window <os_window>` the program is running in. Only available
    on platforms that have ids for their windows, such as X11 and macOS.
 
-
 .. envvar:: TERM
 
    The name of the terminal, defaults to ``xterm-kitty``. See :opt:`term`.
 
-
 .. envvar:: TERMINFO
 
    Path to a directory containing the kitty terminfo database.
 
-
 .. envvar:: KITTY_INSTALLATION_DIR
 
    Path to the kitty installation directory.
 
-
 .. envvar:: COLORTERM
 
    Set to the value ``truecolor`` to indicate that kitty supports 16 million
    colors.
 
-
 .. envvar:: KITTY_LISTEN_ON
 
    Set when the :doc:`remote control <remote-control>` facility is enabled and
    the a socket is used for control via :option:`kitty --listen-on` or :opt:`listen_on`.
-   Contains the path to the socket. Avoids needs to use :option:`kitty @ --to` when
+   Contains the path to the socket. Avoid the need to use :option:`kitty @ --to` when
    issuing remote control commands.
 
-
 .. envvar:: KITTY_PIPE_DATA
 
    Set to data describing the layout of the screen when running child
    programs using :option:`launch --stdin-source` with the contents of the
    screen/scrollback piped to them.
 
-
 .. envvar:: KITTY_CHILD_CMDLINE
 
    Set to the command line of the child process running in the kitty
    window when calling the notification callback program on terminal bell, see
    :opt:`command_on_bell`.
 
-
 .. envvar:: KITTY_COMMON_OPTS
 
    Set with the values of some common kitty options when running
-   kittens, so kittens can use them without needing to load kitty.conf.
+   kittens, so kittens can use them without needing to load :file:`kitty.conf`.
-
 
 .. envvar:: KITTY_SHELL_INTEGRATION
 
    Set when enabling :ref:`shell_integration`. It is automatically removed by
    the shell integration scripts.
+
+.. envvar:: ZDOTDIR
+
+   Set when enabling :ref:`shell_integration` with :program:`zsh`, allowing
+   :program:`zsh` to automatically load the integration script.
+
+.. envvar:: XDG_DATA_DIRS
+
+   Set when enabling :ref:`shell_integration` with :program:`fish`, allowing
+   :program:`fish` to automatically load the integration script.
+
+.. envvar:: ENV
+
+   Set when enabling :ref:`shell_integration` with :program:`bash`, allowing
+   :program:`bash` to automatically load the integration script.

docs/graphics-protocol.rst

@@ -31,6 +31,7 @@ Some programs and libraries that use the kitty graphics protocol:
 * `ranger <https://github.com/ranger/ranger>`_ - a terminal file manager, with
   image previews, see this `PR <https://github.com/ranger/ranger/pull/1077>`_
 * :doc:`kitty-diff <kittens/diff>` - a side-by-side terminal diff program with support for images
+* `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
 * `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
@@ -42,11 +43,13 @@ Some programs and libraries that use the kitty graphics protocol:
 * `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
+* `term-image <https://github.com/AnonymouX47/term-image>`_  - A Python library, CLI and TUI to display and browse images in the terminal
 
 Other terminals that have implemented the graphics protocol:
 
 * `WezTerm <https://github.com/wez/wezterm/issues/986>`_
 * `Konsole <https://invent.kde.org/utilities/konsole/-/merge_requests/594>`_
+* `wayst <https://github.com/91861/wayst>`_
 
 
 Getting the window size
@@ -234,7 +237,8 @@ Value of `t`          Meaning
                       the terminal emulator should only delete the file if it
                       is in a known temporary directory, such as :file:`/tmp`,
                       :file:`/dev/shm`, :file:`TMPDIR env var if present` and any platform
-                      specific temporary directories.
+                      specific temporary directories and the file has the
+                      string :code:`tty-graphics-protocol` in its full file path.
 ``s``                 A *shared memory object*, which on POSIX systems is a
                       `POSIX shared memory object <https://pubs.opengroup.org/onlinepubs/9699919799/functions/shm_open.html>`_
                       and on Windows is a
@@ -326,14 +330,14 @@ 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.
 
-As of September 2021, kitty and WezTerm are the only terminal emulators to support this
+As of April 2022, kitty and WezTerm are the only terminal emulators to
-graphics protocol. We intend that any terminal emulator that wishes to support
+support this graphics protocol completely, with Konsole and wayst having partial support.
-it can do so. To check if a terminal emulator supports the graphics protocol the best way
+We intend that any terminal emulator that wishes to support it can do so. To
-is to send the above *query action* followed by a request for the
+check if a terminal emulator supports the graphics protocol the best way is to
-`primary device attributes <https://vt100.net/docs/vt510-rm/DA1.html>`_. If you
+send the above *query action* followed by a request for the `primary device
-get back an answer for the device attributes without getting back an answer for
+attributes <https://vt100.net/docs/vt510-rm/DA1.html>`_. If you get back an
-the *query action* the terminal emulator does not support the graphics
+answer for the device attributes without getting back an answer for the *query
-protocol.
+action* the terminal emulator does not support the graphics protocol.
 
 This means that terminal emulators that support the graphics protocol, **must**
 reply to *query actions* immediately without processing other input. Most
@@ -376,7 +380,9 @@ 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, it will be ignored. An example response::
+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``.
+An example response::
 
     <ESC>_Gi=<image id>,p=<placement id>;OK<ESC>\
 
@@ -413,7 +419,9 @@ they are semi-transparent. You can specify z-index values using the ``z`` key.
 Negative z-index values mean that the images will be drawn under the text. This
 allows rendering of text on top of images. Negative z-index values below
 INT32_MIN/2 (-1,073,741,824) will be drawn under cells with non-default background
-colors.
+colors. If two images with the same z-index overlap then the image with the
+lower id is considered to have the lower z-index. If the images have the same
+z-index and the same id, then the behavior is undefined.
 
 .. note:: After placing an image on the screen the cursor must be moved to the
    right by the number of cols in the image placement rectangle and down by the

docs/installer.py

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

docs/installer.sh

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

docs/integrations.rst

@@ -4,8 +4,8 @@ Integrations with other tools
 ================================
 
 kitty provides extremely powerful interfaces such as :doc:`remote-control` and
-:doc:`kittens/custom` and :doc:`kittens/icat`
+:doc:`kittens/custom` and :doc:`kittens/icat` that allow it to be integrated
-that allow it to be integrated with other tools seamlessly.
+with other tools seamlessly.
 
 
 Image and document viewers
@@ -30,19 +30,28 @@ Display markdown files nicely formatted with images in the terminal
 
 `ranger <https://github.com/ranger/ranger>`_
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-A terminal file manager, with previews of file contents powered by kitty's graphics protocol.
+A terminal file manager, with previews of file contents powered by kitty's
+graphics protocol.
 
 .. _tool_nnn:
 
 `nnn <https://github.com/jarun/nnn/>`_
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-Another terminal file manager, with previews of file contents powered by kitty's graphics protocol.
+Another terminal file manager, with previews of file contents powered by kitty's
+graphics protocol.
 
 .. _tool_hunter:
 
 `hunter <https://github.com/rabite0/hunter>`_
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-Another terminal file manager, with previews of file contents powered by kitty's graphics protocol.
+Another terminal file manager, with previews of file contents powered by kitty's
+graphics protocol.
+
+.. _tool_term_image:
+
+`term-image <https://github.com/AnonymouX47/term-image>`__
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Tool to browse images in a terminal using kitty's graphics protocol.
 
 .. _tool_koneko:
 
@@ -61,8 +70,8 @@ View images in the terminal, similar to kitty's icat.
 
 `nb <https://github.com/xwmx/nb>`_
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-command line and local web note-taking, bookmarking, archiving, and
+Command line and local web note-taking, bookmarking, archiving, and knowledge
-knowledge base application that uses kitty's graphics protocol for images.
+base application that uses kitty's graphics protocol for images.
 
 .. _tool_w3m:
 
@@ -75,9 +84,9 @@ images.
 
 `timg <https://github.com/hzeller/timg>`_
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-A terminal image and video viewer, that displays static and animated
+A terminal image and video viewer, that displays static and animated images or
-images or plays videos. Fast multi-threaded loading, JPEG exif rotation,
+plays videos. Fast multi-threaded loading, JPEG exif rotation, grid view and
-grid view and connecting to the webcam make it a versatile terminal utility.
+connecting to the webcam make it a versatile terminal utility.
 
 
 System and data visualisation tools
@@ -87,7 +96,8 @@ System and data visualisation tools
 
 `neofetch <https://github.com/dylanaraps/neofetch>`_
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-A command line system information tool that shows images using kitty's graphics protocol
+A command line system information tool that shows images using kitty's graphics
+protocol
 
 .. _tool_matplotlib:
 
@@ -105,16 +115,16 @@ Show images from Julia directly in kitty
 
 `euporie <https://github.com/joouha/euporie>`_
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-A text-based user interface for running and editing Jupyter notebooks,
+A text-based user interface for running and editing Jupyter notebooks, powered
-powered by kitty's graphics protocol for displaying plots
+by kitty's graphics protocol for displaying plots
 
 .. _tool_gnuplot:
 
 `gnuplot <http://www.gnuplot.info/>`_
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-A graphing and data visualization tool that can be made to display its
+A graphing and data visualization tool that can be made to display its output in
-output in kitty with the following bash snippet:
+kitty with the following bash snippet:
 
 .. code-block:: sh
 
@@ -171,26 +181,28 @@ Run applications on your system with fuzzy find inside a kitty window
 Editor integration
 -----------------------
 
-|kitty| can be integrated into many different terminal editors to add features
+|kitty| can be integrated into many different terminal based text editors to add
-such a split windows, previews, REPLs etc.
+features such a split windows, previews, REPLs etc.
 
 .. tool_kakoune:
 
 `kakoune <https://kakoune.org/>`_
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-integrates with kitty to use native kitty windows for its windows/panels and REPLs.
+Integrates with kitty to use native kitty windows for its windows/panels and
+REPLs.
 
 .. tool_vim_slime:
 
 `vim-slime <https://github.com/jpalardy/vim-slime#kitty>`_
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-uses kitty remote control for a Lisp REPL.
+Uses kitty remote control for a Lisp REPL.
 
 .. tool_vim_kitty_navigator:
 
 `vim-kitty-navigator <https://github.com/knubie/vim-kitty-navigator>`_
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-allows you to navigate seamlessly between vim and kitty splits using a consistent set of hotkeys.
+Allows you to navigate seamlessly between vim and kitty splits using a
+consistent set of hotkeys.
 
 .. tool_vim_test:
 
@@ -202,7 +214,7 @@ Allows easily running tests in a terminal window
 
 `hologram.nvim <https://github.com/edluffy/hologram.nvim>`_
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-Terminal image viewer for nvim
+Terminal image viewer for Neovim
 
 
 Scrollback manipulation
@@ -228,21 +240,21 @@ Miscellaneous
 
 `kitty-smart-tab <https://github.com/yurikhan/kitty-smart-tab>`_
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-use keys to either control tabs or pass them onto running applications if
+Use keys to either control tabs or pass them onto running applications if no
-no tabs are present
+tabs are present
 
 .. tool_kitty_smart_scroll:
 
 `kitty-smart-scroll <https://github.com/yurikhan/kitty-smart-scroll>`_
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-use keys to either scroll or pass them onto running applications if
+Use keys to either scroll or pass them onto running applications if no
-no scrollback buffer is present
+scrollback buffer is present
 
 .. tool_kitti3:
 
 `kitti3 <https://github.com/LandingEllipse/kitti3>`_
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-allow using kitty as a drop-down terminal under the i3 window manager
+Allow using kitty as a drop-down terminal under the i3 window manager
 
 .. tool_weechat_hints:
 

docs/keyboard-protocol.rst

@@ -35,9 +35,14 @@ inside the kitty terminal to report key events.
 In addition to kitty, this protocol is also implemented in:
 
 * The `foot terminal <https://codeberg.org/dnkl/foot/issues/319>`__
+* The `WezTerm terminal <https://wezfurlong.org/wezterm/config/lua/config/enable_kitty_keyboard.html>`__
 * The `notcurses library
   <https://github.com/dankamongmen/notcurses/issues/2131>`__
+* The `crossterm library
+  <https://github.com/crossterm-rs/crossterm/pull/688>`__
+* 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>`__
 
 .. versionadded:: 0.20.0
 
@@ -376,7 +381,7 @@ An application can query the terminal for support of this protocol by sending
 the escape code querying for the :ref:`current progressive enhancement
 <progressive_enhancement>` status
 followed by request for the `primary device attributes
-<https://vt100.net/docs/vt510-rm/DA1.html>`. If an answer for the device
+<https://vt100.net/docs/vt510-rm/DA1.html>`__. If an answer for the device
 attributes is received without getting back an answer for the progressive
 enhancement the terminal does not support this protocol.
 

docs/kittens/broadcast.rst

@@ -3,18 +3,21 @@ broadcast
 
 *Type text in all kitty windows simultaneously*
 
-The ``broadcast`` kitten can be used to type text simultaneously in
+The ``broadcast`` kitten can be used to type text simultaneously in all
-all kitty windows (or a subset as desired).
+:term:`kitty windows <window>` (or a subset as desired).
 
 To use it, simply create a mapping in :file:`kitty.conf` such as::
 
-    map F1 launch --allow-remote-control kitty +kitten broadcast
+    map f1 launch --allow-remote-control kitty +kitten broadcast
 
-Then press the :kbd:`F1` key and whatever you type in the newly created widow
+Then press the :kbd:`F1` key and whatever you type in the newly created window
 will be sent to all kitty windows.
 
-You can use the options described below to control which windows
+You can use the options described below to control which windows are selected.
-are selected.
+
+For example, only broadcast to other windows in the current tab::
+
+    map f1 launch --allow-remote-control kitty +kitten broadcast --match-tab state:focused
 
 .. program:: kitty +kitten broadcast
 

docs/kittens/custom.rst

@@ -1,21 +1,20 @@
 Custom kittens
 =================
 
-You can easily create your own kittens to extend kitty. They are just
+You can easily create your own kittens to extend kitty. They are just terminal
-terminal programs written in Python. When launching a kitten, kitty will
+programs written in Python. When launching a kitten, kitty will open an overlay
-open an overlay window over the current window and optionally pass the
+window over the current window and optionally pass the contents of the current
-contents of the current window/scrollback to the kitten over its :file:`STDIN`.
+window/scrollback to the kitten over its :file:`STDIN`. The kitten can then
-The kitten can then perform whatever actions it likes, just as a normal
+perform whatever actions it likes, just as a normal terminal program. After
-terminal program. After execution of the kitten is complete, it has access
+execution of the kitten is complete, it has access to the running kitty instance
-to the running kitty instance so it can perform arbitrary actions
+so it can perform arbitrary actions such as closing windows, pasting text, etc.
-such as closing windows, pasting text, etc.
 
 Let's see a simple example of creating a kitten. It will ask the user for some
 input and paste it into the terminal window.
 
-Create a file in the kitty config folder, :file:`~/.config/kitty/mykitten.py`
+Create a file in the kitty config directory, :file:`~/.config/kitty/mykitten.py`
-(you might need to adjust the path to wherever the kitty config folder is on
+(you might need to adjust the path to wherever the :ref:`kitty config directory
-your machine).
+<confloc>` is on your machine).
 
 
 .. code-block:: python
@@ -35,7 +34,7 @@ your machine).
         # get the kitty window into which to paste answer
         w = boss.window_id_map.get(target_window_id)
         if w is not None:
-            w.paste(answer)
+            w.paste_text(answer)
 
 
 Now in :file:`kitty.conf` add the lines::
@@ -43,11 +42,30 @@ Now in :file:`kitty.conf` add the lines::
     map ctrl+k kitten mykitten.py
 
 
-Start kitty and press :kbd:`ctrl+k` and you should see the kitten running.
+Start kitty and press :kbd:`Ctrl+K` and you should see the kitten running.
-The best way to develop your own kittens is to modify one of the built in
+The best way to develop your own kittens is to modify one of the built-in
-kittens. Look in the kittens sub-directory of the kitty source code for those.
+kittens. Look in the `kittens sub-directory
-Or see below for a list of :ref:`third-party kittens <external_kittens>`,
+<https://github.com/kovidgoyal/kitty/tree/master/kittens>`__ of the kitty source
-that other kitty users have created.
+code for those. Or see below for a list of :ref:`third-party kittens
+<external_kittens>`, that other kitty users have created.
+
+kitty API to use with kittens
+-------------------------------
+
+Kittens have full access to internal kitty APIs. However these are neither
+entirely stable nor documented. You can instead use the kitty
+:doc:`Remote control API </remote-control>`. Simply call
+:code:`boss.call_remote_control()`, with the same arguments you
+would pass to ``kitty @``. For example:
+
+.. code-block:: python
+
+    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:
+            boss.call_remote_control(w, ('send-text', 'hello world'))
+
 
 
 Passing arguments to kittens
@@ -60,36 +78,40 @@ You can pass arguments to kittens by defining them in the map directive in
 
 These will be available as the ``args`` parameter in the ``main()`` and
 ``handle_result()`` functions. Note also that the current working directory
-of the kitten is set to the working directory of whatever program is
+of the kitten is set to the working directory of whatever program is running in
-running in the active kitty window. The special argument ``@selection``
+the active kitty window. The special argument ``@selection`` is replaced by the
-is replaced by the currently selected text in the active kitty window.
+currently selected text in the active kitty window.
 
 
 Passing the contents of the screen to the kitten
 ---------------------------------------------------
 
 If you would like your kitten to have access to the contents of the screen
-and/or the scrollback buffer, you just need to add an annotation to the ``handle_result()``
+and/or the scrollback buffer, you just need to add an annotation to the
-function, telling kitty what kind of input your kitten would like. For example:
+``handle_result()`` function, telling kitty what kind of input your kitten would
+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):
+    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, stdin_data, target_window_id, boss):
+    def handle_result(args: List[str], stdin_data: str, target_window_id: int, boss: Boss) -> None:
         pass
 
 
 This will send the plain text of the active window to the kitten's
-:file:`STDIN`. There are many other types of input you can ask for,
+:file:`STDIN`. There are many other types of input you can ask for, described in
-described in the table below:
+the table below:
 
 .. table:: Types of input to kittens
     :align: left
@@ -121,31 +143,35 @@ and ``first_output`` gives the output of the first command currently on screen.
 These can also be combined with ``screen`` and ``ansi`` for formatting.
 
 .. note::
-   For the types based on the output of a command,
+   For the types based on the output of a command, :ref:`shell_integration` is
-   :ref:`shell_integration` is required.
+   required.
 
 
 Using kittens to script kitty, without any terminal UI
 -----------------------------------------------------------
 
 If you would like your kitten to script kitty, without bothering to write a
-terminal program, you can tell the kittens system to run the
+terminal program, you can tell the kittens system to run the ``handle_result()``
-``handle_result()`` function without first running the ``main()`` function.
+function without first running the ``main()`` function.
 
-For example, here is a kitten that "zooms/unzooms" the current terminal window
+For example, here is a kitten that "zooms in/zooms out" the current terminal
-by switching to the stack layout or back to the previous layout. This is
+window by switching to the stack layout or back to the previous layout. This is
 equivalent to the builtin :ac:`toggle_layout` action.
 
-Create a file in the kitty config folder, :file:`~/.config/kitty/zoom_toggle.py`
+Create a Python file in the :ref:`kitty config directory <confloc>`,
+:file:`~/.config/kitty/zoom_toggle.py`
 
 .. code-block:: py
 
-    def main(args):
+    from typing import List
+    from kitty.boss import Boss
+
+    def main(args: List[str]) -> str:
         pass
 
     from kittens.tui.handler import result_handler
     @result_handler(no_ui=True)
-    def handle_result(args, answer, target_window_id, boss):
+    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':
@@ -154,7 +180,7 @@ Create a file in the kitty config folder, :file:`~/.config/kitty/zoom_toggle.py`
                 tab.goto_layout('stack')
 
 
-Now in kitty.conf add::
+Now in :file:`kitty.conf` add::
 
     map f11 kitten zoom_toggle.py
 
@@ -165,7 +191,7 @@ layout, by simply adding the line::
     boss.toggle_fullscreen()
 
 
-To the ``handle_result()`` function, above.
+to the ``handle_result()`` function, above.
 
 
 .. _send_mouse_event:
@@ -173,7 +199,7 @@ To the ``handle_result()`` function, above.
 Sending mouse events
 --------------------
 
-If the program running in a window is receiving mouse events you can simulate
+If the program running in a window is receiving mouse events, you can simulate
 those using::
 
     from kitty.fast_data_types import send_mouse_event
@@ -200,15 +226,15 @@ that type, and will return ``True`` if it sent the event, and ``False`` if not.
 Debugging kittens
 --------------------
 
-The part of the kitten that runs in ``main()`` is just a normal program and
+The part of the kitten that runs in ``main()`` is just a normal program and the
-the output of print statements will be visible in the kitten window. Or
+output of print statements will be visible in the kitten window. Or alternately,
-alternately, you can use::
+you can use::
 
     from kittens.tui.loop import debug
     debug('whatever')
 
-The ``debug()`` function is just like ``print()`` except that the output
+The ``debug()`` function is just like ``print()`` except that the output will
-will appear in the ``STDOUT`` of the kitty process inside which the kitten is
+appear in the ``STDOUT`` of the kitty process inside which the kitten is
 running.
 
 The ``handle_result()`` part of the kitten runs inside the kitty process.
@@ -216,12 +242,13 @@ The output of print statements will go to the ``STDOUT`` of the kitty process.
 So if you run kitty from another kitty instance, the output will be visible
 in the first kitty instance.
 
+
 Adding options to kittens
 ----------------------------
 
 If you would like to use kitty's config framework to make your kittens
-configurable, you will need some boilerplate. In the directory
+configurable, you will need some boilerplate. Put the following files in the
-of your kitten make the following files.
+directory of your kitten.
 
 :file:`kitten_options_definition.py`
 
@@ -311,8 +338,9 @@ You can parse and read the options in your kitten using the following code:
         opts.config_overrides = overrides
         return opts
 
-See the code for the builtin diff kitten for examples of creating more options
+See `the code <https://github.com/kovidgoyal/kitty/tree/master/kittens/diff>`__
-and keyboard shortcuts.
+for the builtin :doc:`diff kitten </kittens/diff>` for examples of creating more
+options and keyboard shortcuts.
 
 .. _external_kittens:
 
@@ -320,7 +348,8 @@ Kittens created by kitty users
 ---------------------------------------------
 
 `vim-kitty-navigator <https://github.com/knubie/vim-kitty-navigator>`_
-    Allows you to navigate seamlessly between vim and kitty splits using a consistent set of hotkeys.
+    Allows you to navigate seamlessly between vim and kitty splits using a
+    consistent set of hotkeys.
 
 `smart-scroll <https://github.com/yurikhan/kitty-smart-scroll>`_
     Makes the kitty scroll bindings work in full screen applications

docs/kittens/diff.rst

@@ -12,8 +12,8 @@ Major Features
 
     * Displays diffs side-by-side in the kitty terminal
 
-    * Does syntax highlighting of the displayed diffs, asynchronously, for maximum
+    * Does syntax highlighting of the displayed diffs, asynchronously, for
-      speed
+      maximum speed
 
     * Displays images as well as text diffs, even over SSH
 
@@ -31,11 +31,11 @@ Major Features
 Installation
 ---------------
 
-Simply :ref:`install kitty <quickstart>`.  You also need
+Simply :ref:`install kitty <quickstart>`.  You also need to have either the `git
-to have either the `git <https://git-scm.com/>`_ program or the ``diff`` program
+<https://git-scm.com/>`__ program or the :program:`diff` program installed.
-installed. Additionally, for syntax highlighting to work,
+Additionally, for syntax highlighting to work, `pygments
-`pygments <https://pygments.org/>`_ must be installed (note that pygments is
+<https://pygments.org/>`__ must be installed (note that pygments is included in
-included in the official kitty binary builds).
+the official kitty binary builds).
 
 
 Usage
@@ -45,9 +45,10 @@ In the kitty terminal, run::
 
     kitty +kitten diff file1 file2
 
-to see the diff between file1 and file2.
+to see the diff between :file:`file1` and :file:`file2`.
 
-Create an alias in your shell's startup file to shorten the command, for example:
+Create an alias in your shell's startup file to shorten the command, for
+example:
 
 .. code-block:: sh
 
@@ -67,20 +68,20 @@ Keyboard controls
 =========================   ===========================
 Action                      Shortcut
 =========================   ===========================
-Quit                        :kbd:`q`, :kbd:`ctrl+c`, :kbd:`Esc`
+Quit                        :kbd:`Q`, :kbd:`Ctrl+C`, :kbd:`Esc`
-Scroll line up              :kbd:`k`, :kbd:`Up`
+Scroll line up              :kbd:`K`, :kbd:`Up`
-Scroll line down            :kbd:`j`, :kbd:`Down`
+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`
 Scroll to previous page     :kbd:`PgUp`
-Scroll to next change       :kbd:`n`
+Scroll to next change       :kbd:`N`
-Scroll to previous change   :kbd:`p`
+Scroll to previous change   :kbd:`P`
 Increase lines of context   :kbd:`+`
 Decrease lines of context   :kbd:`-`
-All lines of context        :kbd:`a`
+All lines of context        :kbd:`A`
 Restore default context     :kbd:`=`
 Search forwards             :kbd:`/`
 Search backwards            :kbd:`?`
@@ -93,7 +94,7 @@ Scroll to previous match    :kbd:`<`, :kbd:`,`
 Integrating with git
 -----------------------
 
-Add the following to `~/.gitconfig`:
+Add the following to :file:`~/.gitconfig`:
 
 .. code-block:: ini
 
@@ -119,24 +120,23 @@ Why does this work only in kitty?
 ----------------------------------------
 
 The diff kitten makes use of various features that are :doc:`kitty only
-</protocol-extensions>`,  such as the :doc:`kitty graphics protocol
+</protocol-extensions>`, such as the :doc:`kitty graphics protocol
 </graphics-protocol>`, the :doc:`extended keyboard protocol
-</keyboard-protocol>`, etc. It also leverages terminal program
+</keyboard-protocol>`, etc. It also leverages terminal program infrastructure
-infrastructure I created for all of kitty's other kittens to reduce the amount
+I created for all of kitty's other kittens to reduce the amount of code needed
-of code needed (the entire implementation is under 2000 lines of code).
+(the entire implementation is under 2000 lines of code).
 
 And fundamentally, it's kitty only because I wrote it for myself, and I am
 highly unlikely to use any other terminals :)
 
 
-
 Configuration
 ------------------------
 
 You can configure the colors used, keyboard shortcuts, the diff implementation,
-the default lines of context, etc.  by creating a :file:`diff.conf` file in
+the default lines of context, etc. by creating a :file:`diff.conf` file in your
-your :ref:`kitty config folder <confloc>`. See below for the supported
+:ref:`kitty config folder <confloc>`. See below for the supported configuration
-configuration directives.
+directives.
 
 
 .. include:: /generated/conf-kitten-diff.rst
@@ -145,7 +145,6 @@ configuration directives.
 .. include:: /generated/cli-kitten-diff.rst
 
 
-
 Sample diff.conf
 -----------------
 

docs/kittens/hints.rst

@@ -1,9 +1,9 @@
 Hints
 ==========
 
-|kitty| has a *hints mode* to select and act on arbitrary text snippets currently
+|kitty| has a *hints mode* to select and act on arbitrary text snippets
-visible on the screen.  For example, you can press :sc:`open_url`
+currently visible on the screen.  For example, you can press :sc:`open_url`
-to choose any URL visible on the screen and then open it using your system
+to choose any URL visible on the screen and then open it using your default web
 browser.
 
 .. figure:: ../screenshots/hints_mode.png
@@ -13,25 +13,29 @@ browser.
 
     URL hints mode
 
-Similarly, you can press :sc:`insert_selected_path` to
+Similarly, you can press :sc:`insert_selected_path` to select anything that
-select anything that looks like a path or filename and then insert it into the
+looks like a path or filename and then insert it into the terminal, very useful
-terminal, very useful for picking files from the output of a ``git`` or ``ls`` command and
+for picking files from the output of a :program:`git` or :program:`ls` command
-adding them to the command line for the next command.
+and adding them to the command line for the next command.
 
-You can also press :sc:`goto_file_line` to select anything that looks
+You can also press :sc:`goto_file_line` to select anything that looks like a
-like a path or filename followed by a colon and a line number and open
+path or filename followed by a colon and a line number and open the file in
-the file in vim at the specified line number. The patterns and editor
+:program:`vim` at the specified line number. The patterns and editor to be used
-to be used can be modified using options passed to the kitten. For example::
+can be modified using options passed to the kitten. For example::
 
     map ctrl+g kitten hints --type=linenum --linenum-action=tab nvim +{line} {path}
 
-will open the selected file in a new tab inside neovim when you press
+will open the selected file in a new tab inside `Neovim <https://neovim.io/>`__
-:kbd:`ctrl+g`.
+when you press :kbd:`Ctrl+G`.
 
-Pressing :sc:`open_selected_hyperlink` will open hyperlinks, i.e. a URL
+Pressing :sc:`open_selected_hyperlink` will open :term:`hyperlinks`, i.e. a URL
 that has been marked as such by the program running in the terminal,
-for example, by ``ls --hyperlink=auto``. You can also :doc:`customize what actions are
+for example, by ``ls --hyperlink=auto``. If :program:`ls` comes with your OS
-taken for different types of URLs <../open_actions>`.
+does not support hyperlink, you may need to install `GNU Coreutils
+<https://www.gnu.org/software/coreutils/>`__.
+
+You can also :doc:`customize what actions are taken for different types of URLs
+<../open_actions>`.
 
 .. note:: If there are more hints than letters, hints will use multiple
    letters. In this case, when you press the first letter, only hints
@@ -48,13 +52,12 @@ snippets. See :sc:`insert_selected_path <insert_selected_path>` for examples.
 Completely customizing the matching and actions of the kitten
 ---------------------------------------------------------------
 
-The hints kitten supports writing simple python scripts that can be used to
+The hints kitten supports writing simple Python scripts that can be used to
 completely customize how it finds matches and what happens when a match is
-selected. This allows the hints kitten to provide the user interface, while
+selected. This allows the hints kitten to provide the user interface, while you
-you can provide the logic for finding matches and performing actions on them.
+can provide the logic for finding matches and performing actions on them. This
-This is best illustrated with an example. Create the file
+is best illustrated with an example. Create the file :file:`custom-hints.py` in
-:file:`custom-hints.py` in the kitty config directory with the following
+the :ref:`kitty config directory <confloc>` with the following contents:
-contents:
 
 .. code-block:: python
 
@@ -98,9 +101,10 @@ look it up in the Google dictionary.
 
 .. note::
 
-    To avoid having to specify the same command line options on every invocation,
+    To avoid having to specify the same command line options on every
-    you can use the :opt:`action_alias` option in :file:`kitty.conf`, creating aliases
+    invocation, you can use the :opt:`action_alias` option in
-    that have common sets of options. For example::
+    :file:`kitty.conf`, creating aliases that have common sets of options.
+    For example::
 
         action_alias myhints kitten hints --alphabet qfjdkslaureitywovmcxzpq1234567890
         map f1 myhints --customize-processing custom-hints.py

docs/kittens/hyperlinked_grep.rst

@@ -1,11 +1,10 @@
 Hyperlinked grep
 =================
 
-
 This kitten allows you to search your files using `ripgrep
-<https://github.com/BurntSushi/ripgrep>`_ and open the results
+<https://github.com/BurntSushi/ripgrep>`__ and open the results directly in your
-directly in your favorite editor in the terminal, at the line containing
+favorite editor in the terminal, at the line containing the search result,
-the search result, simply by clicking on the result you want.
+simply by clicking on the result you want.
 
 .. versionadded:: 0.19.0
 
@@ -25,19 +24,19 @@ following contents:
     mime text/*
     action launch --type=overlay ${EDITOR} ${FILE_PATH}
 
-
 Now, run a search with::
 
     kitty +kitten hyperlinked_grep something
 
-Hold down the :kbd:`ctrl+shift` keys and click on any of the
+Hold down the :kbd:`Ctrl+Shift` keys and click on any of the result lines, to
-result lines, to open the file in vim at the matching line. If
+open the file in :program:`vim` at the matching line. If you use some editor
-you use some editor other than vim, you should adjust the
+other than :program:`vim`, you should adjust the :file:`open-actions.conf` file
-:file:`open-actions.conf` file accordingly.
+accordingly.
 
-Finally, add an alias to your shell's rc files to invoke the kitten as ``hg``::
+Finally, add an alias to your shell's rc files to invoke the kitten as
+:command:`hg`::
 
-    alias hg='kitty +kitten hyperlinked_grep'
+    alias hg="kitty +kitten hyperlinked_grep"
 
 
 You can now run searches with::
@@ -45,13 +44,13 @@ You can now run searches with::
     hg some-search-term
 
 If you want to enable completion, for the kitten, you can delegate completion
-to rg. How to do that varies based on the shell:
+to :program:`rg`. How to do that varies based on the shell:
 
 
 .. tab:: zsh
 
-    Instead of using an alias create a simple wrapper script named
+    Instead of using an alias, create a simple wrapper script named
-    :file:`hg` somewhere in your ``PATH``:
+    :program:`hg` somewhere in your :envvar:`PATH`:
 
     .. code-block:: sh
 
@@ -64,22 +63,33 @@ to rg. How to do that varies based on the shell:
 
 .. tab:: fish
 
-    You can combine both the aliasing/wrapping and pointing fish
+    You can combine both the aliasing/wrapping and pointing fish to ripgrep's
-    to rg's autocompletion with a fish "wrapper" function in your :file:`config.fish`:
+    autocompletion with a fish wrapper function in your :file:`config.fish`
+    or :file:`~/.config/fish/functions/hg.fish`:
 
-    .. code-block:: sh
+    .. code-block:: fish
 
         function hg --wraps rg; kitty +kitten hyperlinked_grep $argv; end
 
 To learn more about kitty's powerful framework for customizing URL click
-actions, :doc:`see here </open_actions>`.
+actions, see :doc:`here </open_actions>`.
+
+By default, this kitten adds hyperlinks for several parts of ripgrep output:
+the per-file header, match context lines, and match lines. You can control
+which items are linked with a :command:`--kitten hyperlink` flag. For example,
+:command:`--kitten hyperlink=matching_lines` will only add hyperlinks to the
+match lines. :command:`--kitten hyperlink=file_headers,context_lines` will link
+file headers and context lines but not match lines. :command:`--kitten
+hyperlink=none` will cause the command line to be passed to directly to
+:command:`rg` so no hyperlinking will be performed. :command:`--kitten
+hyperlink` may be specified multiple times.
 
 Hopefully, someday this functionality will make it into some `upstream grep
-<https://github.com/BurntSushi/ripgrep/issues/665>`_
+<https://github.com/BurntSushi/ripgrep/issues/665>`__ program directly removing
-program directly removing the need for this kitten.
+the need for this kitten.
 
 
 .. note::
    While you can pass any of ripgrep's comand line options to the kitten and
-   they will be forwarded to rg, do not use options that change the output
+   they will be forwarded to :program:`rg`, do not use options that change the
-   formatting as the kitten works by parsing the output from ripgrep.
+   output formatting as the kitten works by parsing the output from ripgrep.

docs/kittens/icat.rst

@@ -9,8 +9,8 @@ terminal. Using it is as simple as::
     kitty +kitten icat image.jpeg
 
 It supports all image types supported by `ImageMagick
-<https://www.imagemagick.org>`_. It even works over SSH. For details, see
+<https://www.imagemagick.org>`__. It even works over SSH. For details, see the
-the :doc:`kitty graphics protocol </graphics-protocol>`.
+:doc:`kitty graphics protocol </graphics-protocol>`.
 
 You might want to create an alias in your shell's configuration files::
 
@@ -20,14 +20,14 @@ Then you can simply use ``icat image.png`` to view images.
 
 .. note::
 
-    `ImageMagick <https://www.imagemagick.org>`_ must be installed for ``icat`` to
+    `ImageMagick <https://www.imagemagick.org>`__ must be installed for icat
-    work.
+    kitten to work.
 
 .. note::
 
     kitty's image display protocol may not work when used within a terminal
-    multiplexer such as ``screen`` or ``tmux``, depending on whether the
+    multiplexer such as :program:`screen` or :program:`tmux`, depending on
-    multiplexer has added support for it or not.
+    whether the multiplexer has added support for it or not.
 
 
 .. program:: kitty +kitten icat
@@ -35,18 +35,19 @@ Then you can simply use ``icat image.png`` to view images.
 
 The ``icat`` kitten has various command line arguments to allow it to be used
 from inside other programs to display images. In particular, :option:`--place`,
-:option:`--detect-support`, :option:`--silent` and :option:`--print-window-size`.
+:option:`--detect-support`, :option:`--silent` and
+:option:`--print-window-size`.
 
-If you are trying to integrate icat into a complex program like a file
+If you are trying to integrate icat into a complex program like a file manager
-manager or editor, there are a few things to keep in mind. icat works by
+or editor, there are a few things to keep in mind. icat works by communicating
-communicating over the TTY device, it both writes to and reads from the TTY.
+over the TTY device, it both writes to and reads from the TTY. So it is
-So it is imperative that while it is running the host program does not do
+imperative that while it is running the host program does not do any TTY I/O.
-any TTY I/O. Any key presses or other input from the user on the TTY device
+Any key presses or other input from the user on the TTY device will be
-will be discarded. At a minimum, you should use the :option:`--silent` and
+discarded. At a minimum, you should use the :option:`--silent` and
-:option:`--transfer-mode` command line arguments. To be
+:option:`--transfer-mode` command line arguments. To be really robust you should
-really robust you should consider writing proper support for the
+consider writing proper support for the :doc:`kitty graphics protocol
-:doc:`../graphics-protocol` in the program instead.  Nowadays there are many
+</graphics-protocol>` in the program instead. Nowadays there are many libraries
-libraries that have support for it.
+that have support for it.
 
 
 .. include:: /generated/cli-kitten-icat.rst

docs/kittens/panel.rst

@@ -4,8 +4,8 @@ Draw a GPU accelerated dock panel on your desktop
 .. highlight:: sh
 
 
-You can use this kitten to draw a GPU accelerated panel on the edge
+You can use this kitten to draw a GPU accelerated panel on the edge of your
-of your screen, that shows the output from an arbitrary terminal program.
+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.
@@ -32,8 +32,8 @@ Using this kitten is simple, for example::
     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 ``sh`` with a script to
+seconds. Here the terminal program we are running is :program:`sh` with a script
-print out ``Hello, world!``. You can make the terminal program as complex as
+to print out ``Hello, world!``. You can make the terminal program as complex as
 you like, as demonstrated in the screenshot above.
 
 

docs/kittens/query_terminal.rst

@@ -1,18 +1,18 @@
 Query terminal
 =================
 
-Used to query kitty from terminal programs about version, values of various
+This kitten is used to query |kitty| from terminal programs about version, values
-runtime options controlling its features, etc.
+of various runtime options controlling its features, etc.
 
 The querying is done using the (*semi*) standard XTGETTCAP escape sequence
-pioneered by XTerm, so it works over SSH as well. The downside is that it
+pioneered by xterm, so it works over SSH as well. The downside is that it is
-is slow, since it requires a roundtrip to the terminal emulator and back.
+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>`_
+Search `this page <https://invisible-island.net/xterm/ctlseqs/ctlseqs.html>`__
-for *XTGETTCAP* to see the syntax for the escape code and read the source
+for *XTGETTCAP* to see the syntax for the escape code and read the source of
-of this kitten to find the values of the keys for the various queries.
+this kitten to find the values of the keys for the various queries.
 
 
 .. include:: ../generated/cli-kitten-query_terminal.rst

docs/kittens/remote_file.rst

@@ -1,12 +1,12 @@
 Remote files
 ==============
 
-|kitty| has the ability to easily *Edit*, *Open* or *Download* files
+|kitty| has the ability to easily *Edit*, *Open* or *Download* files from a
-from a computer into which you are SSHed. In your SSH session run::
+computer into which you are SSHed. In your SSH session run::
 
     ls --hyperlink=auto
 
-Then hold down :kbd:`ctrl+shift` and click the name of the file.
+Then hold down :kbd:`Ctrl+Shift` and click the name of the file.
 
 .. figure:: ../screenshots/remote_file.png
     :alt: Remote file actions
@@ -19,23 +19,28 @@ Then hold down :kbd:`ctrl+shift` and click the name of the file.
 to *Edit* it in which case kitty will download it and open it locally in your
 :envvar:`EDITOR`. As you make changes to the file, they are automatically
 transferred to the remote computer. Note that this happens without needing
-to install *any* special software on the server, beyond ``ls`` that supports
+to install *any* special software on the server, beyond :program:`ls` that
-hyperlinks.
+supports hyperlinks.
+
+.. seealso:: See the :ref:`edit-in-kitty <edit_file>` command
 
 .. seealso:: See the :doc:`transfer` kitten
 
 .. versionadded:: 0.19.0
 
 .. note::
-   Nested SSH sessions are not supported. The kitten will always try to copy
+   For best results, use this kitten with the :doc:`ssh kitten <./ssh>`.
-   remote files from the first SSH host. This is because there is no way for
+   Otherwise, nested SSH sessions are not supported. The kitten will always try to copy
+   remote files from the first SSH host. This is because, without the ssh
+   kitten, there is no way for
    |kitty| to detect and follow a nested SSH session robustly. Use the
    :doc:`transfer` kitten for such situations.
 
 .. note::
-   If you have not setup automatic password-less SSH access, then, when
+   If you have not setup automatic password-less SSH access, and are not using
-   editing starts you will be asked to enter your password just once,
+   the ssh kitten, then, when editing
-   thereafter the SSH connection will be re-used.
+   starts you will be asked to enter your password just once, thereafter the SSH
+   connection will be re-used.
 
 Similarly, you can choose to save the file to the local computer or download
 and open it in its default file handler.

docs/kittens/ssh.rst

@@ -0,0 +1,164 @@
+Truly convenient SSH
+=========================================
+
+* Automatic :ref:`shell_integration` on remote hosts
+
+* Easily :ref:`clone local shell/editor config <real_world_ssh_kitten_config>` on remote hosts
+
+* Automatic :opt:`re-use of existing connections <kitten-ssh.share_connections>` to avoid connection setup latency
+
+* Make kitty itself available in the remote host :opt:`on demand <kitten-ssh.remote_kitty>`
+
+* Easily :opt:`change terminal colors <kitten-ssh.color_scheme>` when connecting to remote hosts
+
+.. versionadded:: 0.25.0
+   Automatic shell integration, file transfer and reuse of connections
+
+The ssh kitten allows you to login easily to remote hosts, and automatically
+setup the environment there to be as comfortable as your local shell. You can
+specify environment variables to set on the remote host and files to copy there,
+making your remote experience just like your local shell. Additionally, it
+automatically sets up :ref:`shell_integration` on the remote host and copies the
+kitty terminfo database there.
+
+The ssh kitten is a thin wrapper around the traditional `ssh <https://man.openbsd.org/ssh>`__
+command line program and supports all the same options and arguments and configuration.
+In interactive usage scenarios it is a drop in replacement for :program:`ssh`.
+To try it out, simply run:
+
+.. code-block:: sh
+
+    kitty +kitten ssh some-hostname-to-connect-to
+
+You should end up at a shell prompt on the remote host, with shell integration
+enabled. If you like it you can add an alias to it in your shell's rc files:
+
+.. code-block:: sh
+
+    alias s="kitty +kitten ssh"
+
+So now you can just type ``s hostname`` to connect.
+
+If you define a mapping in :file:`kitty.conf` such as::
+
+    map f1 new_window_with_cwd
+
+Then, pressing :kbd:`F1` will open a new window automatically logged into the
+same host using the ssh kitten, at the same directory.
+
+The ssh kitten can be configured using the :file:`~/.config/kitty/ssh.conf` file
+where you can specify environment variables to set on the remote host and files
+to copy from the local to the remote host. Let's see a quick example:
+
+.. code-block:: conf
+
+   # Copy the files and directories needed to setup some common tools
+   copy .zshrc .vimrc .vim
+   # Setup some environment variables
+   env SOME_VAR=x
+   # COPIED_VAR will have the same value on the remote host as it does locally
+   env COPIED_VAR=_kitty_copy_env_var_
+
+   # Create some per hostname settings
+   hostname someserver-*
+   copy env-files
+   env SOMETHING=else
+
+   hostname someuser@somehost
+   copy --dest=foo/bar some-file
+   copy --glob some/files.*
+
+
+See below for full details on the syntax and options of :file:`ssh.conf`.
+Additionally, you can pass config options on the command line:
+
+.. code-block:: sh
+
+   kitty +kitten ssh --kitten interpreter=python servername
+
+The :code:`--kitten` argument can be specified multiple times, with directives
+from :file:`ssh.conf`. These are merged with :file:`ssh.conf` as if they were
+appended to the end of that file. They apply only to the host being SSHed to by
+this invocation, so any :opt:`hostname <kitten-ssh.hostname>` directives are
+ignored.
+
+.. warning::
+
+   Due to limitations in the design of SSH, any typing you do before the
+   shell prompt appears may be lost. So ideally don't start typing till you see
+   the shell prompt. 😇
+
+
+.. _real_world_ssh_kitten_config:
+
+A real world example
+----------------------
+
+Suppose you often SSH into a production server, and you would like to setup
+your shell and editor there using your custom settings. However, other people
+could SSH in as well and you don't want to clobber their settings. Here is how
+this could be achieved using the ssh kitten with :program:`zsh` and
+:program:`vim` as the shell and editor, respectively:
+
+.. code-block:: conf
+
+   # Have these settings apply to servers in my organization
+   hostname myserver-*
+
+   # Setup zsh to read its files from 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
+   copy --dest my-conf/vim .vim
+   copy --dest my-conf/vim/vimrc .vimrc
+
+
+How it works
+----------------
+
+The ssh kitten works by having SSH transmit and execute a POSIX sh (or
+:opt:`optionally <kitten-ssh.interpreter>` Python) bootstrap script on the
+remote host using an :opt:`interpreter <kitten-ssh.interpreter>`. This script
+reads setup data over the TTY device, which kitty sends as a Base64 encoded
+compressed tarball. The script extracts it and places the :opt:`files <kitten-ssh.copy>`
+and sets the :opt:`environment variables <kitten-ssh.env>` before finally
+launching the :opt:`login shell <kitten-ssh.login_shell>` with :opt:`shell
+integration <kitten-ssh.shell_integration>` enabled. The data is requested by
+the kitten over the TTY with a random one time password. kitty reads the request
+and if the password matches a password pre-stored in shared memory on the
+localhost by the kitten, the transmission is allowed. If your local
+`OpenSSH <https://www.openssh.com/>`__ version is >= 8.4 then the data is
+transmitted instantly without any roundtrip delay.
+
+.. note::
+
+   When connecting to BSD hosts, it is possible the bootstrap script will fail
+   or run slowly, because the default shells are crippled in various ways.
+   Your best bet is to install Python on the remote, make sure the login shell
+   is something POSIX sh compliant, and use :code:`python` as the
+   :opt:`interpreter <kitten-ssh.interpreter>` in :file:`ssh.conf`.
+
+
+.. note::
+
+   This may or may not work when using terminal multiplexers, depending on
+   whether they passthrough the escape codes and if the values of the
+   environment variables :envvar:`KITTY_PID` and :envvar:`KITTY_WINDOW_ID` are
+   correct in the current session (they can be wrong when connecting to a tmux
+   session running in a different window) and the ssh kitten is run in the
+   currently active multiplexer window.
+
+.. include:: /generated/conf-kitten-ssh.rst
+
+
+.. _ssh_copy_command:
+
+The copy command
+--------------------
+
+.. include:: /generated/ssh-copy.rst

docs/kittens/themes.rst

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

docs/kittens/transfer.rst

@@ -14,16 +14,16 @@ etc. Anywhere you have a terminal device, you can transfer files.
    :alt: The transfer kitten at work
 
 This kitten supports transferring entire directory trees, preserving soft and
-hard links, file permissions, times, etc. It even supports the rsync_
+hard links, file permissions, times, etc. It even supports the rsync_ protocol
-protocol to transfer only changes to large files.
+to transfer only changes to large files.
 
 .. seealso:: See the :doc:`remote_file` kitten
 
 .. note::
    This kitten (which practically means kitty) must be installed on the other
    machine as well. If that is not possible you can use the :doc:`remote_file`
-   kitten instead. Or write your own script to use the underlying :doc:`file transfer
+   kitten instead. Or write your own script to use the underlying
-   protocol </file-transfer-protocol>`.
+   :doc:`file transfer protocol </file-transfer-protocol>`.
 
 .. versionadded:: 0.24.0
 
@@ -32,7 +32,8 @@ Basic usage
 ---------------
 
 In what follows, the *local computer* is the computer running this kitten and
-the *remote computer* is the computer connected to the other end of the TTY pipe.
+the *remote computer* is the computer connected to the other end of the TTY
+pipe.
 
 To send a file from the local computer to the remote computer, simply run::
 
@@ -42,7 +43,7 @@ You will be prompted by kitty for confirmation on allowing the transfer, and if
 you grant permission, the file will be copied.
 
 Similarly, to get a file from the remote computer to the local computer, use
-the :option:`kitty +kitten transfer --direction` option::
+the :option:`--direction <kitty +kitten transfer --direction>` option::
 
     kitty +kitten transfer --direction=receive /path/to/remote/file /path/to/destination/on/local/computer
 
@@ -58,25 +59,25 @@ the fact that you are copying multiple things) it is good practice to always
 use a trailing slash when the destination is supposed to be a directory.
 
 Also, when transferring multiple files/directories it is a good idea to
-use the :option:`kitty +kitten transfer --confirm-paths` option which will give
+use the :option:`--confirm-paths <kitty +kitten transfer --confirm-paths>`
-you an opportunity to review and confirm the files that will be touched.
+option which will give you an opportunity to review and confirm the files that
+will be touched.
 
 
 Avoiding the confirmation prompt
 ------------------------------------
 
-Normally, when you start a file transfer kitty will prompt you for
+Normally, when you start a file transfer kitty will prompt you for confirmation.
-confirmation. This is to ensure that hostile programs running on a remote
+This is to ensure that hostile programs running on a remote machine cannot
-machine cannot read/write files on your computer without your permission.
+read/write files on your computer without your permission. If the remote machine
-If the remote machine is trusted and the connection between your computer
+is trusted and the connection between your computer and the remote machine is
-and the remote machine is secure, then you can disable the confirmation prompt
+secure, then you can disable the confirmation prompt by:
-by:
 
-#. Setting the :opt:`file_transfer_confirmation_bypass` option to some
+#. Setting the :opt:`file_transfer_confirmation_bypass` option to some password.
-   password.
 
-#. When invoking the kitten use the :option:`kitty +kitten transfer --permissions-bypass`
+#. When invoking the kitten use the :option:`--permissions-bypass
-   to supply the password you set in step one.
+   <kitty +kitten transfer --permissions-bypass>` to supply the password you set
+   in step one.
 
 .. warning:: Using a password to bypass confirmation means any software running
    on the remote machine could potentially learn that password and use it to
@@ -89,9 +90,10 @@ Delta transfers
 -----------------------------------
 
 This kitten has the ability to use the rsync_ protocol to only transfer the
-differences between files. To turn it on use the :option:`kitty +kitten
+differences between files. To turn it on use the :option:`--transmit-deltas
-transfer --transmit-deltas` option. Note that this will actually be slower when
+<kitty +kitten transfer --transmit-deltas>` option. Note that this will actually
-transferring small files because of round trip overhead, so use with care.
+be slower when transferring small files because of round trip overhead, so use
+with care.
 
 
 .. include:: ../generated/cli-kitten-transfer.rst

docs/kittens/unicode_input.rst

@@ -1,27 +1,29 @@
 Unicode input
 ================
 
-You can input unicode characters by name, hex code, recently used and even an editable favorites list.
+You can input Unicode characters by name, hex code, recently used and even an
-Press :sc:`input_unicode_character` to start the unicode input widget, shown below.
+editable favorites list. Press :sc:`input_unicode_character` to start the
+unicode input kitten, shown below.
 
 .. figure:: ../screenshots/unicode.png
-    :alt: A screenshot of the unicode input widget
+    :alt: A screenshot of the unicode input kitten
     :align: center
     :width: 100%
 
-    A screenshot of the unicode input widget
+    A screenshot of the unicode input kitten
 
-In :guilabel:`Code` mode, you enter a unicode character by typing in the hex code for the
+In :guilabel:`Code` mode, you enter a Unicode character by typing in the hex
-character and pressing enter, for example, type in ``2716`` and press enter to get
+code for the character and pressing :kbd:`Enter`. For example, type in ``2716``
-✖. You can also choose a character from the list of recently used characters by
+and press :kbd:`Enter` to get ``✖``. You can also choose a character from the
-typing a leading period and then the two character index and pressing Enter.
+list of recently used characters by typing a leading period ``.`` and then the
-The up and down arrow keys can be used to choose the previous and next unicode
+two character index and pressing :kbd:`Enter`.
-symbol respectively.
+The :kbd:`Up` and :kbd:`Down` arrow keys can be used to choose the previous and
+next Unicode symbol respectively.
 
 In :guilabel:`Name` mode you instead type words from the character name and use
-the arrow keys/tab to select the character from the displayed matches. You can
+the :kbd:`ArrowKeys` / :kbd:`Tab` to select the character from the displayed
-also type a space followed by a period and the index for the match if you don't
+matches. You can also type a space followed by a period and the index for the
-like to use arrow keys.
+match if you don't like to use arrow keys.
 
 You can switch between modes using either the keys :kbd:`F1` ... :kbd:`F4` or
 :kbd:`Ctrl+1` ... :kbd:`Ctrl+4` or by pressing :kbd:`Ctrl+[` and :kbd:`Ctrl+]`

docs/kittens_intro.rst

@@ -15,12 +15,13 @@ Extend with kittens
    kittens/remote_file
    kittens/hyperlinked_grep
    kittens/transfer
+   kittens/ssh
    kittens/custom
    kittens/*
 
 |kitty| has a framework for easily creating terminal programs that make use of
-its advanced features. These programs are called kittens. They are used both
+its advanced features. These programs are called kittens. They are used both to
-to add features to |kitty| itself and to create useful standalone programs.
+add features to |kitty| itself and to create useful standalone programs.
 Some prominent kittens:
 
 :doc:`icat <kittens/icat>`
@@ -32,8 +33,8 @@ Some prominent kittens:
     images
 
 
-:doc:`Unicode Input <kittens/unicode_input>`
+:doc:`Unicode input <kittens/unicode_input>`
-    Easily input arbitrary unicode characters in |kitty| by name or hex code.
+    Easily input arbitrary Unicode characters in |kitty| by name or hex code.
 
 
 :doc:`Hints <kittens/hints>`
@@ -47,24 +48,31 @@ Some prominent kittens:
 
 
 :doc:`Transfer files <kittens/transfer>`
-    Transfer files and directories seamlessly and easily from remote machines over your existing
+    Transfer files and directories seamlessly and easily from remote machines
-    SSH sessions with a simple command.
+    over your existing SSH sessions with a simple command.
 
 
 :doc:`Hyperlinked grep <kittens/hyperlinked_grep>`
-    Search your files using `ripgrep <https://github.com/BurntSushi/ripgrep>`_
+    Search your files using `ripgrep <https://github.com/BurntSushi/ripgrep>`__
     and open the results directly in your favorite editor in the terminal,
-    at the line containing the search result, simply by clicking on the result you want.
+    at the line containing the search result, simply by clicking on the result
+    you want.
 
 
 :doc:`Broadcast <kittens/broadcast>`
-    Type in one :term:`kitty window <window>` and have it broadcast to all (or a subset) of
+    Type in one :term:`kitty window <window>` and have it broadcast to all (or a
-    other :term:`kitty windows <window>`.
+    subset) of other :term:`kitty windows <window>`.
+
+
+:doc:`SSH <kittens/ssh>`
+    SSH with automatic :ref:`shell integration <shell_integration>`, connection
+    re-use for low latency and easy cloning of local shell and editor
+    configuration to the remote host.
 
 
 :doc:`Panel <kittens/panel>`
-    Draw a GPU accelerated dock panel on your desktop showing the output
+    Draw a GPU accelerated dock panel on your desktop showing the output from an
-    from an arbitrary terminal program.
+    arbitrary terminal program.
 
 
 :doc:`Clipboard <kittens/clipboard>`

docs/kitty_at_template.py

@@ -0,0 +1,295 @@
+#!/usr/bin/env python
+# License: GPLv3 Copyright: 2022, Kovid Goyal <kovid at kovidgoyal.net>
+import argparse
+import base64
+import hashlib
+import json
+import os
+import sys
+import termios
+import time
+import tty
+from contextlib import contextmanager
+from ctypes import (
+    CDLL, POINTER, byref, c_char_p, c_int, c_size_t, c_void_p,
+    create_string_buffer
+)
+from ctypes.util import find_library
+
+_plat = sys.platform.lower()
+is_macos: bool = 'darwin' in _plat
+
+
+def build_crypto_tools():  # {{{
+    class EVP_PKEY_POINTER(c_void_p):
+
+        algorithm = 0
+
+        def __del__(self):
+            EVP_PKEY_free(self)
+
+        @property
+        def public(self):
+            sz = c_size_t(0)
+            EVP_PKEY_get_raw_public_key(self, None, byref(sz))
+            buf = create_string_buffer(sz.value)
+            EVP_PKEY_get_raw_public_key(self, buf, byref(sz))
+            return buf.raw
+
+        def derive_secret(self, pubkey):
+            pubkey = EVP_PKEY_new_raw_public_key(self.algorithm, None, pubkey, len(pubkey))
+            ctx = EVP_PKEY_CTX_new(self, None)
+            EVP_PKEY_derive_init(ctx)
+            EVP_PKEY_derive_set_peer(ctx, pubkey)
+            sz = c_size_t(0)
+            EVP_PKEY_derive(ctx, None, byref(sz))
+            buf = create_string_buffer(sz.value)
+            EVP_PKEY_derive(ctx, buf, byref(sz))
+            return hashlib.sha256(buf.raw).digest()
+
+    class EVP_PKEY_CTX_POINTER(c_void_p):
+
+        def __del__(self):
+            EVP_PKEY_CTX_free(self)
+
+    class EVP_CIPHER_CTX_POINTER(c_void_p):
+
+        def __del__(self):
+            EVP_CIPHER_CTX_free(self)
+
+    class EVP_CIPHER_POINTER(c_void_p):
+        pass
+
+    cl = find_library('crypto')
+    if not cl:
+        raise SystemExit('Failed to find libcrypto on your system, make sure OpenSSL is installed')
+    crypto = CDLL(cl)
+    libc = CDLL(None)
+
+    def create_crypto_func(name, *argtypes, restype=c_int, int_return_ok=lambda x: x == 1):
+
+        impl = getattr(crypto, name)
+        impl.restype = restype
+        impl.argtypes = argtypes
+
+        def func(*a):
+            res = impl(*a)
+            if restype is c_int:
+                if not int_return_ok(res):
+                    print('Call to', name, 'failed with return code:', res, file=sys.stderr)
+                    abort_on_openssl_error()
+            elif restype is not None and issubclass(restype, c_void_p):
+                if res.value is None:
+                    print('Call to', name, 'failed with NULL return', file=sys.stderr)
+                    abort_on_openssl_error()
+            return res
+        return func
+
+    OBJ_txt2nid = create_crypto_func('OBJ_txt2nid', c_char_p, int_return_ok=bool)
+    EVP_PKEY_CTX_new_id = create_crypto_func('EVP_PKEY_CTX_new_id', c_int, c_void_p, restype=EVP_PKEY_CTX_POINTER)
+    EVP_PKEY_CTX_new = create_crypto_func('EVP_PKEY_CTX_new', EVP_PKEY_POINTER, c_void_p, restype=EVP_PKEY_CTX_POINTER)
+    EVP_PKEY_keygen_init = create_crypto_func('EVP_PKEY_keygen_init', EVP_PKEY_CTX_POINTER)
+    EVP_PKEY_keygen = create_crypto_func('EVP_PKEY_keygen', EVP_PKEY_CTX_POINTER, POINTER(EVP_PKEY_POINTER))
+    ERR_print_errors_fp = create_crypto_func('ERR_print_errors_fp', c_void_p, restype=None)
+    EVP_PKEY_free = create_crypto_func('EVP_PKEY_free', EVP_PKEY_POINTER, restype=None)
+    EVP_PKEY_CTX_free = create_crypto_func('EVP_PKEY_CTX_free', EVP_PKEY_CTX_POINTER, restype=None)
+    EVP_PKEY_get_raw_public_key = create_crypto_func('EVP_PKEY_get_raw_public_key', EVP_PKEY_POINTER, c_char_p, POINTER(c_size_t))
+    EVP_PKEY_new_raw_public_key = create_crypto_func('EVP_PKEY_new_raw_public_key', c_int, c_void_p, c_char_p, c_size_t, restype=EVP_PKEY_POINTER)
+    EVP_PKEY_derive_init = create_crypto_func('EVP_PKEY_derive_init', EVP_PKEY_CTX_POINTER)
+    EVP_PKEY_derive_set_peer = create_crypto_func('EVP_PKEY_derive_set_peer', EVP_PKEY_CTX_POINTER, EVP_PKEY_POINTER)
+    EVP_PKEY_derive = create_crypto_func('EVP_PKEY_derive', EVP_PKEY_CTX_POINTER, c_char_p, POINTER(c_size_t))
+    EVP_CIPHER_CTX_free = create_crypto_func('EVP_CIPHER_CTX_free', EVP_CIPHER_CTX_POINTER, restype=None)
+    EVP_get_cipherbyname = create_crypto_func('EVP_get_cipherbyname', c_char_p, restype=EVP_CIPHER_POINTER)
+    EVP_CIPHER_key_length = create_crypto_func('EVP_CIPHER_key_length', EVP_CIPHER_POINTER, int_return_ok=bool)
+    EVP_CIPHER_iv_length = create_crypto_func('EVP_CIPHER_iv_length', EVP_CIPHER_POINTER, int_return_ok=bool)
+    EVP_CIPHER_CTX_block_size = create_crypto_func('EVP_CIPHER_CTX_block_size', EVP_CIPHER_CTX_POINTER, int_return_ok=bool)
+    EVP_CIPHER_CTX_new = create_crypto_func('EVP_CIPHER_CTX_new', restype=EVP_CIPHER_CTX_POINTER)
+    EVP_EncryptInit_ex = create_crypto_func('EVP_EncryptInit_ex', EVP_CIPHER_CTX_POINTER, EVP_CIPHER_POINTER, c_void_p, c_char_p, c_char_p)
+    EVP_EncryptUpdate = create_crypto_func('EVP_EncryptUpdate', EVP_CIPHER_CTX_POINTER, c_char_p, POINTER(c_int), c_char_p, c_int)
+    EVP_EncryptFinal_ex = create_crypto_func('EVP_EncryptFinal_ex', EVP_CIPHER_CTX_POINTER, c_char_p, POINTER(c_int))
+    EVP_CIPHER_CTX_ctrl = create_crypto_func('EVP_CIPHER_CTX_ctrl', EVP_CIPHER_CTX_POINTER, c_int, c_int, c_char_p)
+    try:
+        EVP_CIPHER_CTX_tag_length = create_crypto_func('EVP_CIPHER_CTX_tag_length', EVP_CIPHER_CTX_POINTER, int_return_ok=bool)
+    except AttributeError:  # need openssl >= 3
+        def EVP_CIPHER_CTX_tag_length(cipher):
+            return 16
+    EVP_CTRL_AEAD_GET_TAG, EVP_CTRL_AEAD_SET_TAG = 0x10, 0x11  # these are defines in the header dont know how to get them programmatically
+    EVP_CTRL_AEAD_SET_TAG
+
+    def abort_on_openssl_error():
+        stderr = c_void_p.in_dll(libc, 'stderr')
+        ERR_print_errors_fp(stderr)
+        raise SystemExit(1)
+
+    def elliptic_curve_keypair(algorithm='X25519'):
+        nid = OBJ_txt2nid(algorithm.encode())
+        pctx = EVP_PKEY_CTX_new_id(nid, None)
+        EVP_PKEY_keygen_init(pctx)
+        key = EVP_PKEY_POINTER()
+        EVP_PKEY_keygen(pctx, byref(key))
+        key.algorithm = nid
+        return key
+
+    def encrypt(plaintext, symmetric_key, algorithm='aes-256-gcm'):
+        cipher = EVP_get_cipherbyname(algorithm.encode())
+        if len(symmetric_key) != EVP_CIPHER_key_length(cipher):
+            raise KeyError(f'The symmetric key has length {len(symmetric_key)} != {EVP_CIPHER_key_length(cipher)} needed for {algorithm}')
+        ctx = EVP_CIPHER_CTX_new()
+        iv = os.urandom(EVP_CIPHER_iv_length(cipher))
+        EVP_EncryptInit_ex(ctx, cipher, None, symmetric_key, iv)
+        bs = EVP_CIPHER_CTX_block_size(ctx)
+        ciphertext = create_string_buffer(len(plaintext) + 2 * bs)
+        outlen = c_int(len(ciphertext))
+        EVP_EncryptUpdate(ctx, ciphertext, byref(outlen), plaintext, len(plaintext))
+        ans = ciphertext[:outlen.value]
+        outlen = c_int(len(ciphertext))
+        EVP_EncryptFinal_ex(ctx, ciphertext, byref(outlen))
+        if outlen.value:
+            ans += ciphertext[:outlen.value]
+        tag = create_string_buffer(EVP_CIPHER_CTX_tag_length(cipher))
+        EVP_CIPHER_CTX_ctrl(ctx, EVP_CTRL_AEAD_GET_TAG, len(tag), tag)
+        return iv, ans, tag.raw
+    return elliptic_curve_keypair, encrypt
+# }}}
+
+
+# utils {{{
+def encrypt_cmd(cmd, password, pubkey=None):
+    elliptic_curve_keypair, encrypt = build_crypto_tools()
+    if pubkey is None:
+        pubkey = os.environ['KITTY_PUBLIC_KEY']
+        v, d = pubkey.split(':', 1)
+        if v != '1':
+            raise SystemExit(f'Unsupported encryption protocol: {v}')
+        pubkey = base64.b85decode(d)
+    k = elliptic_curve_keypair()
+    sk = k.derive_secret(pubkey)
+    cmd['timestamp'] = time.time_ns()
+    cmd['password'] = password
+    data = json.dumps(cmd).encode()
+    iv, encrypted, tag = encrypt(data, sk)
+
+    def e(x):
+        return base64.b85encode(x).decode('ascii')
+
+    return {
+        'encrypted': e(encrypted), 'iv': e(iv), 'tag': e(tag), 'pubkey': e(k.public), 'version': cmd['version']
+    }
+
+
+@contextmanager
+def raw_mode(fd):
+    old = termios.tcgetattr(fd)
+    try:
+        tty.setraw(fd)
+        yield
+    finally:
+        termios.tcsetattr(fd, termios.TCSADRAIN, old)
+
+
+def config_dir():
+    if 'KITTY_CONFIG_DIRECTORY' in os.environ:
+        return os.path.abspath(os.path.expanduser(os.environ['KITTY_CONFIG_DIRECTORY']))
+    locations = []
+    if 'XDG_CONFIG_HOME' in os.environ:
+        locations.append(os.path.abspath(os.path.expanduser(os.environ['XDG_CONFIG_HOME'])))
+    locations.append(os.path.expanduser('~/.config'))
+    if is_macos:
+        locations.append(os.path.expanduser('~/Library/Preferences'))
+    for loc in filter(None, os.environ.get('XDG_CONFIG_DIRS', '').split(os.pathsep)):
+        locations.append(os.path.abspath(os.path.expanduser(loc)))
+    for loc in locations:
+        if loc:
+            q = os.path.join(loc, 'kitty')
+            if os.access(q, os.W_OK) and os.path.exists(os.path.join(q, 'kitty.conf')):
+                return q
+    for loc in locations:
+        if loc:
+            q = os.path.join(loc, 'kitty')
+            if os.path.isdir(q) and os.access(q, os.W_OK):
+                return q
+    return ''
+
+
+def resolve_custom_file(path):
+    path = os.path.expanduser(path)
+    path = os.path.expandvars(path)
+    if not os.path.isabs(path):
+        cdir = config_dir()
+        if cdir:
+            path = os.path.join(cdir, path)
+    return path
+
+
+def get_password(opts):
+    if opts.use_password == 'never':
+        return ''
+    ans = ''
+    if opts.password:
+        ans = opts.password
+    if not ans and opts.password_file:
+        if opts.password_file == '-':
+            if sys.stdin.isatty():
+                from getpass import getpass
+                ans = getpass()
+            else:
+                ans = sys.stdin.read().rstrip()
+                try:
+                    tty_fd = os.open(os.ctermid(), os.O_RDONLY | os.O_CLOEXEC)
+                except OSError:
+                    pass
+                else:
+                    with open(tty_fd, closefd=True):
+                        os.dup2(tty_fd, sys.stdin.fileno())
+        else:
+            try:
+                with open(resolve_custom_file(opts.password_file)) as f:
+                    ans = f.read().rstrip()
+            except OSError:
+                pass
+    if not ans and opts.password_env:
+        ans = os.environ.get(opts.password_env, '')
+    if not ans and opts.use_password == 'always':
+        raise SystemExit('No password was found')
+    if ans and len(ans) > 1024:
+        raise SystemExit('Specified password is too long')
+    return ans
+# }}}
+
+
+arg_parser = argparse.ArgumentParser(prog='kitty@', description='Control kitty remotely.')
+arg_parser.add_argument('--password', default='', help='''\
+A password to use when contacting kitty. This will cause kitty to ask the user
+for permission to perform the specified action, unless the password has been
+accepted before or is pre-configured in kitty.conf''')
+arg_parser.add_argument('--password-file', default='rc-pass', help='''\
+A file from which to read the password. Trailing whitespace is ignored. Relative
+paths are resolved from the kitty configuration directory. Use - to read from STDIN.
+Used if no --password is supplied. Defaults to checking for the
+rc-pass file in the kitty configuration directory.''')
+arg_parser.add_argument('--password-env', default='KITTY_RC_PASSWORD', help='''\
+The name of an environment variable to read the password from.
+Used if no --password-file is supplied. Defaults to checking the KITTY_RC_PASSWORD.''')
+arg_parser.add_argument('--use-password', default='if-available', choices=('if-available', 'always', 'never'), help='''\
+If no password is available, kitty will usually just send the remote control command
+without a password. This option can be used to force it to always or never use
+the supplied password.''')
+
+args = arg_parser.parse_args()
+
+
+def populate_cmd(cmd):
+    raise NotImplementedError()
+
+
+password = get_password(args)
+cmd = {'version': [0, 20, 0]}  # use a random version that's fairly old
+populate_cmd(cmd)
+if password:
+    encrypt_cmd(cmd, password)
+
+# cmd = {'version': [0, 14, 2], 'cmd': 'ls'}
+# cmd = encrypt_cmd(cmd, 'test')
+# with open(os.open(os.ctermid(), os.O_RDWR | os.O_CLOEXEC), 'w') as tty_file, raw_mode(tty_file.fileno()):
+#     print(end=f'\x1bP@kitty-cmd{json.dumps(cmd)}\x1b\\', flush=True, file=tty_file)
+#     os.read(tty_file.fileno(), 4096)

docs/launch.rst

@@ -5,22 +5,21 @@ The :command:`launch` command
 
 
 |kitty| has a :code:`launch` action that can be used to run arbitrary programs
-in new windows/tabs. It can be mapped to user defined shortcuts in kitty.conf.
+in new windows/tabs. It can be mapped to user defined shortcuts in
-It is very powerful and allows sending the contents of
+:file:`kitty.conf`. It is very powerful and allows sending the contents of the
-the current window to the launched program, as well as many other options.
+current window to the launched program, as well as many other options.
 
 In the simplest form, you can use it to open a new kitty window running the
 shell, as shown below::
 
     map f1 launch
 
-To run a different program simply pass the command line as arguments to
+To run a different program simply pass the command line as arguments to launch::
-launch::
 
     map f1 launch vim path/to/some/file
 
-To open a new window with the same working directory as the currently
+To open a new window with the same working directory as the currently active
-active window::
+window::
 
     map f1 launch --cwd=current
 
@@ -30,9 +29,10 @@ To open the new window in a new tab::
 
 To run multiple commands in a shell, use::
 
-    map f1 launch sh -c "ls && zsh"
+    map f1 launch sh -c "ls && exec zsh"
 
-To pass the contents of the current screen and scrollback to the started process::
+To pass the contents of the current screen and scrollback to the started
+process::
 
     map f1 launch --stdin-source=@screen_scrollback less
 
@@ -46,16 +46,16 @@ There are many more powerful options, refer to the complete list below.
         map f1 launch_tab vim
         map f2 launch_tab emacs
 
-    The :kbd:`F1` key will now open vim in a new tab with the current windows
+    The :kbd:`F1` key will now open :program:`vim` in a new tab with the current
-    working directory
+    windows working directory.
 
 
 The piping environment
 --------------------------
 
 When using :option:`launch --stdin-source`, the program to which the data is
-piped has a special environment variable declared, :envvar:`KITTY_PIPE_DATA` whose
+piped has a special environment variable declared, :envvar:`KITTY_PIPE_DATA`
-contents are::
+whose contents are::
 
    KITTY_PIPE_DATA={scrolled_by}:{cursor_x},{cursor_y}:{lines},{columns}
 
@@ -73,33 +73,33 @@ the command line:
 
 
 ``@selection``
-    replaced by the currently selected text
+    Replaced by the currently selected text.
 
 ``@active-kitty-window-id``
-    replaced by the id of the currently active kitty window
+    Replaced by the id of the currently active kitty window.
 
 ``@line-count``
-    replaced by the number of lines in STDIN. Only present when passing some
+    Replaced by the number of lines in STDIN. Only present when passing some
-    data to STDIN
+    data to STDIN.
 
 ``@input-line-number``
-    replaced the number of lines a pager should scroll to match the current
+    Replaced the number of lines a pager should scroll to match the current
-    scroll position in kitty. See :opt:`scrollback_pager` for details
+    scroll position in kitty. See :opt:`scrollback_pager` for details.
 
 ``@scrolled-by``
-    replaced by the number of lines kitty is currently scrolled by
+    Replaced by the number of lines kitty is currently scrolled by.
 
 ``@cursor-x``
-    replaced by the current cursor x position with 1 being the leftmost cell
+    Replaced by the current cursor x position with 1 being the leftmost cell.
 
 ``@cursor-y``
-    replaced by the current cursor y position with 1 being the topmost cell
+    Replaced by the current cursor y position with 1 being the topmost cell.
 
 ``@first-line-on-screen``
-    replaced by the first line on screen. Can be used for pager positioning.
+    Replaced by the first line on screen. Can be used for pager positioning.
 
 ``@last-line-on-screen``
-    replaced by the last line on screen. Can be used for pager positioning.
+    Replaced by the last line on screen. Can be used for pager positioning.
 
 
 For example::
@@ -112,44 +112,51 @@ For example::
 Watching launched windows
 ---------------------------
 
-The :option:`launch --watcher` option allows you to specify python functions
+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. Simply specify the path to a python module that specifies callback
+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
 
-    def on_resize(boss, window, data):
+    from typing import Any, Dict
+
+    from kitty.boss import Boss
+    from kitty.window import Window
+
+
+    def on_resize(boss: Boss, window: Window, data: Dict[str, Any]) -> None:
         # Here data will contain old_geometry and new_geometry
 
-    def on_focus_change(boss, window, data):
+    def on_focus_change(boss: Boss, window: Window, data: Dict[str, Any])-> None:
         # Here data will contain focused
 
-    def on_close(boss, window, data):
+    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.
 
 
 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
+the ``Window`` object the action is occurring on. The ``data`` object is a dict
-a dict that contains event dependent data. Some useful methods and attributes
+that contains event dependent data. Some useful methods and attributes for the
-for the ``Window`` object are: ``as_text(as_ans=False, add_history=False,
+``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
+in the window and ``window.id`` is the internal kitty ``id`` of the window.
-window.
 
 
 Finding executables
 -----------------------
 
 When you specify a command to run as just a name rather than an absolute path,
-it is searched for in the system-wide ``PATH`` environment variable. Note that
+it is searched for in the system-wide :envvar:`PATH` environment variable. Note
-this **may not** be the value of ``PATH`` inside a shell, as shell startup scripts
+that this **may not** be the value of :envvar:`PATH` inside a shell, as shell
-often change the value of this variable. If it is not found there, then a
+startup scripts often change the value of this variable. If it is not found
-system specific list of default paths is searched. If it is still not found,
+there, then a system specific list of default paths is searched. If it is still
-then your shell is run and the value of ``PATH`` inside the shell is used.
+not found, then your shell is run and the value of :envvar:`PATH` inside the
+shell is used.
+
 See :opt:`exe_search_path` for details and how to control this.
 
 Syntax reference

docs/layouts.rst

@@ -10,7 +10,8 @@ other in arbitrary arrangements, based on *Layouts*, see below for examples:
     :align: center
     :width: 100%
 
-    Screenshot, showing vim, tig and git running in |kitty| with the 'Tall' layout
+    Screenshot, showing :program:`vim`, :program:`tig` and :program:`git`
+    running in |kitty| with the *Tall* layout
 
 
 .. figure:: screenshots/splits.png
@@ -18,21 +19,22 @@ other in arbitrary arrangements, based on *Layouts*, see below for examples:
     :align: center
     :width: 100%
 
-    Screenshot, showing windows with arbitrary arrangement in the 'Splits'
+    Screenshot, showing windows with arbitrary arrangement in the *Splits*
     layout
 
 
-There are many different layouts available. They are all enabled by default,
+There are many different layouts available. They are all enabled by default, you
-you can switch layouts using :sc:`next_layout`. To control which layouts
+can switch layouts using :ac:`next_layout` (:sc:`next_layout` by default). To
-are available use :opt:`enabled_layouts`, the first listed layout becomes
+control which layouts are available use :opt:`enabled_layouts`, the first listed
-the default. Individual layouts and how to use them are described below.
+layout becomes the default. Individual layouts and how to use them are described
+below.
 
 
 The Stack Layout
 ------------------
 
-This is the simplest layout it displays a single window using all available
+This is the simplest layout. It displays a single window using all available
-space, other windows are hidden behind it. It has no options::
+space, other windows are hidden behind it. This layout has no options::
 
     enabled_layouts stack
 
@@ -40,14 +42,14 @@ space, other windows are hidden behind it. It has no options::
 The Tall Layout
 ------------------
 
-Displays one (or optionally more) full height windows on the left half of the
+Displays one (or optionally more) full-height windows on the left half of the
 screen. Remaining windows are tiled vertically on the right half of the screen.
 There are options to control how the screen is split horizontally ``bias``
 (an integer between ``10`` and ``90``) and options to control how many
 full-height windows there are ``full_size`` (a positive integer). The
-``mirrored`` option when set to ``true`` will cause the short windows to be
+``mirrored`` option when set to ``true`` will cause the full-height windows to
-on the left side of the screen instead of the right. The syntax
+be on the right side of the screen instead of the left. The syntax
-for the options is shown below::
+for the options is::
 
     enabled_layouts tall:bias=50;full_size=1;mirrored=false
 
@@ -65,24 +67,32 @@ for the options is shown below::
     │              │               │
     └──────────────┴───────────────┘
 
-In addition, you can map keys to increase or decrease the number of full size
+In addition, you can map keys to increase or decrease the number of full-height
-windows, for example::
+windows, or toggle the mirrored setting, for example::
 
    map ctrl+[ layout_action decrease_num_full_size_windows
    map ctrl+] layout_action increase_num_full_size_windows
+   map ctrl+/ layout_action mirror toggle
+   map ctrl+y layout_action mirror true
+   map ctrl+n layout_action mirror false
 
+You can also map a key to change the bias by providing a list of percentages
+and it will rotate through the list as you press the key. If you only provide
+one number it'll toggle between that percentage and 50, for example::
+
+   map ctrl+. layout_action bias 50 62 70
+   map ctrl+, layout_action bias 62
 
 The Fat Layout
 ----------------
 
-Displays one (or optionally more) full width windows on the top half of the
+Displays one (or optionally more) full-width windows on the top half of the
-screen. Remaining windows are tiled horizontally on the bottom half of the screen.
+screen. Remaining windows are tiled horizontally on the bottom half of the
-There are options to control how the screen is split vertically ``bias``
+screen. There are options to control how the screen is split vertically ``bias``
 (an integer between ``10`` and ``90``) and options to control how many
-full-height windows there are ``full_size`` (a positive integer). The
+full-width windows there are ``full_size`` (a positive integer). The
-``mirrored`` option when set to ``true`` will cause the narrow windows to be
+``mirrored`` option when set to ``true`` will cause the full-width windows to be
-on the top of the screen instead of the bottom. The syntax for the options is
+on the bottom of the screen instead of the top. The syntax for the options is::
-shown below::
 
     enabled_layouts fat:bias=50;full_size=1;mirrored=false
 
@@ -100,11 +110,15 @@ shown below::
     └─────────┴──────────┴─────────┘
 
 
+This layout also supports the same layout actions as the *Tall* layout, shown above.
+
+
 The Grid Layout
 --------------------
 
 Display windows in a balanced grid with all windows the same size except the
-last column if there are not enough windows to fill the grid. Has no options::
+last column if there are not enough windows to fill the grid. This layout has no
+options::
 
     enabled_layouts grid
 
@@ -132,20 +146,20 @@ define a few extra key bindings in :file:`kitty.conf`::
 
     # Create a new window splitting the space used by the existing one so that
     # the two windows are placed one above the other
-    map F5 launch --location=hsplit
+    map f5 launch --location=hsplit
 
     # Create a new window splitting the space used by the existing one so that
     # the two windows are placed side by side
-    map F6 launch --location=vsplit
+    map f6 launch --location=vsplit
 
     # Create a new window splitting the space used by the existing one so that
     # the two windows are placed side by side if the existing window is wide or
     # one above the other if the existing window is tall.
-    map F4 launch --location=split
+    map f4 launch --location=split
 
     # Rotate the current split, chaging its split axis from vertical to
     # horizontal or vice versa
-    map F7 layout_action rotate
+    map f7 layout_action rotate
 
     # Move the active window in the indicated direction
     map shift+up move_window up
@@ -159,16 +173,16 @@ define a few extra key bindings in :file:`kitty.conf`::
     map ctrl+up neighboring_window up
     map ctrl+down neighboring_window down
 
-Windows can be resized using :ref:`window_resizing`.  You can swap the windows
+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``.
 
 This layout takes one option, ``split_axis`` that controls whether new windows
-are placed into vertical or horizontal splits when a ``--location`` is not
+are placed into vertical or horizontal splits when a :option:`--location <launch
-specified. A value of ``horizontal`` (same as ``--location=vsplit``)
+--location>` is not specified. A value of ``horizontal`` (same as
-means when a new split is created the two windows will be placed side by side
+``--location=vsplit``) means when a new split is created the two windows will be
-and a value of ``vertical`` (same as ``--location=hsplit``) means the two
+placed side by side and a value of ``vertical`` (same as ``--location=hsplit``)
-windows will be placed one on top of the other. By default::
+means the two windows will be placed one on top of the other. By default::
 
     enabled_layouts splits:split_axis=horizontal
 
@@ -193,7 +207,7 @@ windows will be placed one on top of the other. By default::
 The Horizontal Layout
 ------------------------
 
-All windows are shown side by side. Has no options::
+All windows are shown side by side. This layout has no options::
 
     enabled_layouts horizontal
 
@@ -213,7 +227,7 @@ All windows are shown side by side. Has no options::
 The Vertical Layout
 -----------------------
 
-All windows are shown one below the other. Has no options::
+All windows are shown one below the other. This layout has no options::
 
     enabled_layouts vertical
 
@@ -239,14 +253,14 @@ Resizing windows
 
 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
+instructions. In a given window layout only some operations may be possible for
-for a particular window. For example, in the Tall layout you can make the first
+a particular window. For example, in the *Tall* layout you can make the first
 window wider/narrower, but not taller/shorter. Note that what you are resizing
 is actually not a window, but a row/column in the layout, all windows in that
 row/column will be resized.
 
 You can also define shortcuts in :file:`kitty.conf` to make the active window
-wider, narrower, taller, or shorter by mapping to the ``resize_window``
+wider, narrower, taller, or shorter by mapping to the :ac:`resize_window`
 action, for example::
 
    map ctrl+left resize_window narrower
@@ -256,22 +270,21 @@ action, for example::
    # reset all windows in the tab to default sizes
    map ctrl+home resize_window reset
 
-The ``resize_window`` action has a second, optional argument to control
+The :ac:`resize_window` action has a second optional argument to control
 the resizing increment (a positive integer that defaults to 1).
 
-
+Some layouts take options to control their behavior. For example, the *Fat*
-Some layouts take options to control their behavior. For example, the ``fat``
+and *Tall* layouts accept the ``bias`` and ``full_size`` options to control
-and ``tall`` layouts accept the ``bias`` and ``full_size`` options to control
+how the available space is split up. To specify the option, in :opt:`kitty.conf
-how the available space is split up.
+<enabled_layouts>` use::
-To specify the option, in :opt:`kitty.conf <enabled_layouts>` use::
 
     enabled_layouts tall:bias=70;full_size=2
 
 This will have ``2`` instead of a single tall window, that occupy ``70%``
-instead of ``50%`` of available width. ``bias`` can be any number between 10
+instead of ``50%`` of available width. ``bias`` can be any number between ``10``
-and 90.
+and ``90``.
 
 Writing a new layout only requires about two hundred lines of code, so if there
 is some layout you want, take a look at one of the existing layouts in the
-`layout <https://github.com/kovidgoyal/kitty/tree/master/kitty/layout>`_
+`layout <https://github.com/kovidgoyal/kitty/tree/master/kitty/layout>`__
 package and submit a pull request!

docs/marks.rst

@@ -9,12 +9,12 @@ running programs or similar. Lets start with a few examples:
 Examples
 ----------
 
-Suppose we want to be able to highlight the word ERROR in the current window.
+Suppose we want to be able to highlight the word :code:`ERROR` in the current
-Add the following to :file:`kitty.conf`::
+window. Add the following to :file:`kitty.conf`::
 
     map f1 toggle_marker text 1 ERROR
 
-Now when you press :kbd:`F1` all instances of the word :code:`ERROR` will be
+Now when you press :kbd:`F1`, all instances of the word :code:`ERROR` will be
 highlighted. To turn off the highlighting, press :kbd:`F1` again.
 If you want to make it case-insensitive, use::
 
@@ -39,41 +39,40 @@ can control the colors used for these groups in :file:`kitty.conf` with::
 
 
 .. note::
-    For performance reasons, matching is done per line only, and only when that line is
+    For performance reasons, matching is done per line only, and only when that
-    altered in any way. So you cannot match text that stretches across multiple
+    line is altered in any way. So you cannot match text that stretches across
-    lines.
+    multiple lines.
 
 
 Creating markers dynamically
 ---------------------------------
 
 If you want to create markers dynamically rather than pre-defining them in
-:file:`kitty.conf` you can do so as follows::
+:file:`kitty.conf`, you can do so as follows::
 
     map f1 create_marker
     map f2 remove_marker
 
-Then pressing :kbd:`F1` will allow you to enter the marker definition and set
+Then pressing :kbd:`F1` will allow you to enter the marker definition and set it
-it and pressing :kbd:`F2` will remove the marker. ``create_marker`` accepts
+and pressing :kbd:`F2` will remove the marker. :ac:`create_marker` accepts the
-the same syntax as ``toggle_marker`` above. Note that while creating
+same syntax as :ac:`toggle_marker` above. Note that while creating markers, the
-markers, the prompt has history so you can easily re-use previous marker
+prompt has history so you can easily re-use previous marker expressions.
-expressions.
 
-You can also use the facilities for :doc:`remote-control` to dynamically
+You can also use the facilities for :doc:`remote-control` to dynamically add or
-add/remove markers.
+remove markers.
 
 
 Scrolling to marks
 --------------------
 
-kitty has an action to scroll to the next line that contains a mark. You can
+kitty has a :ac:`scroll_to_mark` action to scroll to the next line that contains
-use it by mapping it to some shortcut in :file:`kitty.conf`::
+a mark. You can use it by mapping it to some shortcut in :file:`kitty.conf`::
 
     map ctrl+p scroll_to_mark prev
     map ctrl+n scroll_to_mark next
 
-Then pressing :kbd:`ctrl+p` will scroll to the first line in the scrollback
+Then pressing :kbd:`Ctrl+P` will scroll to the first line in the scrollback
-buffer above the current top line that contains a mark. Pressing :kbd:`ctrl+n`
+buffer above the current top line that contains a mark. Pressing :kbd:`Ctrl+N`
 will scroll to show the first line below the current last line that contains
 a mark. If you wish to jump to a mark of a specific type, you can add that to
 the mapping::
@@ -86,26 +85,26 @@ Which will scroll only to marks of type 1.
 The full syntax for creating marks
 -------------------------------------
 
-The syntax of the :code:`toggle_marker` command is::
+The syntax of the :ac:`toggle_marker` action is::
 
     toggle_marker <marker-type> <specification>
 
 Here :code:`marker-type` is one of:
 
-* :code:`text` - simple substring matching
+* :code:`text` - Simple substring matching
-* :code:`itext` - case-insensitive substring matching
+* :code:`itext` - Case-insensitive substring matching
-* :code:`regex` - A python regular expression
+* :code:`regex` - A Python regular expression
-* :code:`iregex` - A case-insensitive python regular expression
+* :code:`iregex` - A case-insensitive Python regular expression
-* :code:`function` - An arbitrary function defined in a python file, see :ref:`marker_funcs`.
+* :code:`function` - An arbitrary function defined in a Python file, see :ref:`marker_funcs`.
 
 .. _marker_funcs:
 
 Arbitrary marker functions
 -----------------------------
 
-You can create your own marker functions. Create a python file named
+You can create your own marker functions. Create a Python file named
-:file:`mymarker.py` and in it create a :code:`marker` function. This
+:file:`mymarker.py` and in it create a :code:`marker` function. This function
-function receives the text of the line as input and must yield three numbers,
+receives the text of the line as input and must yield three numbers,
 the starting character position, the ending character position and the mark
 group (1-3). For example:
 
@@ -122,6 +121,7 @@ Save this file somewhere and in :file:`kitty.conf`, use::
 
     map f1 toggle_marker function /path/to/mymarker.py
 
-If you save the file in the kitty config directory, you can use::
+If you save the file in the :ref:`kitty config directory <confloc>`, you can
+use::
 
     map f1 toggle_marker function mymarker.py

docs/open_actions.rst

@@ -1,15 +1,14 @@
 Scripting the mouse click
 ======================================================
 
-|kitty| has support for `terminal hyperlinks
+|kitty| has support for :term:`terminal hyperlinks <hyperlinks>`. These are
-<https://gist.github.com/egmontkob/eb114294efbcd5adb1944c9f3cb5feda>`_. These
+generated by many terminal programs, such as ``ls``, ``gcc``, ``systemd``,
-are generated by many terminal programs, such as ``ls``, ``gcc``, ``systemd``,
+:ref:`tool_mdcat`, etc. You can customize exactly what happens when clicking on
-:ref:`tool_mdcat`, etc. You can customize exactly what happens when clicking on these
+these hyperlinks in |kitty|.
-hyperlinks in |kitty|.
 
-You can tell kitty to take arbitrarily many, complex actions
+You can tell kitty to take arbitrarily many, complex actions when a link is
-when a link is clicked. Let us illustrate with some examples, first. Create
+clicked. Let us illustrate with some examples, first. Create the file
-the file :file:`~/.config/kitty/open-actions.conf` with the following:
+:file:`~/.config/kitty/open-actions.conf` with the following:
 
 .. code:: conf
 
@@ -22,6 +21,13 @@ 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
 window. Press any key to close it.
 
+.. note::
+
+    The :program:`ls` comes with macOS does not support hyperlink, you need to
+    install `GNU Coreutils <https://www.gnu.org/software/coreutils/>`__. If you
+    install it via `Homebrew <https://formulae.brew.sh/formula/coreutils>`__, it
+    will be :program:`gls`.
+
 Each entry in :file:`open-actions.conf` consists of one or more
 :ref:`matching_criteria`, such as ``protocol`` and ``mime`` and one or more
 ``action`` entries. In the example above kitty uses the :doc:`launch <launch>`
@@ -29,8 +35,8 @@ action which can be used to run external programs. Entries are separated by
 blank lines.
 
 Actions are very powerful, anything that you can map to a key combination in
-`kitty.conf` can be used as an action. You can specify more than one action per
+:file:`kitty.conf` can be used as an action. You can specify more than one
-entry if you like, for example:
+action per entry if you like, for example:
 
 
 .. code:: conf
@@ -58,9 +64,13 @@ some special variables, documented below:
 ``FRAGMENT``
     The fragment (unquoted), if any of the URL or the empty string.
 
+``URL_PATH``
+    The path, query and fragment portions of the URL, without any
+    unquoting.
+
 
 .. note::
-   You can use the :opt:`action_alias` option just as in kitty.conf to
+   You can use the :opt:`action_alias` option just as in :file:`kitty.conf` to
    define aliases for frequently used actions.
 
 
@@ -77,7 +87,7 @@ lines. The various available criteria are:
 
 ``protocol``
     A comma separated list of protocols, for example: ``http, https``. If
-    absent, there is no constraint on protocol
+    absent, there is no constraint on protocol.
 
 ``url``
     A regular expression that must match against the entire (unquoted) URL
@@ -88,11 +98,12 @@ lines. The various available criteria are:
 
 ``mime``
     A comma separated list of MIME types, for example: ``text/*, image/*,
-    application/pdf``. You can add MIME types to kitty by creating the
+    application/pdf``. You can add MIME types to kitty by creating a file named
-    :file:`mime.types` in the kitty configuration directory. Useful if your
+    :file:`mime.types` in the :ref:`kitty configuration directory <confloc>`.
-    system MIME database does not have definitions you need. This file is
+    Useful if your system MIME database does not have definitions you need. This
-    in the standard format of one definition per line, like: ``text/plain rst
+    file is in the standard format of one definition per line, like:
-    md``. Note that the MIME type for directories is ``inode/directory``.
+    ``text/plain rst md``. Note that the MIME type for directories is
+    ``inode/directory``.
 
 ``ext``
     A comma separated list of file extensions, for example: ``jpeg, tar.gz``
@@ -116,9 +127,10 @@ URLs onto the kitty dock icon to open them with kitty. The default actions are:
 
 These actions can also be executed from the command line by running::
 
-    open -a kitty.app file_or_url ... (on macOS only)
+    kitty +open file_or_url another_url ...
-    or
+
-    kitty +open file_or_url ...
+    # macOS only
+    open -a kitty.app file_or_url another_url ...
 
 Since macOS lacks an official interface to set default URL scheme handlers,
 kitty has a command you can use for it. The first argument for is the URL
@@ -133,36 +145,10 @@ defaults to kitty, if not specified. For example:
     kitty +runpy 'from kitty.fast_data_types import cocoa_set_url_handler; import sys; cocoa_set_url_handler(*sys.argv[1:]); print("OK")' xyz someapp.bundle.identifier
 
 You can customize these actions by creating a :file:`launch-actions.conf` file
-in the kitty config directory, just like
+in the :ref:`kitty config directory <confloc>`, just like the
-the :file:`open-actions.conf` file above. For example:
+:file:`open-actions.conf` file above. For example:
 
-.. code:: conf
+.. literalinclude:: ../kitty/open_actions.py
-
+   :language: conf
-    # Open script files based on their shebangs
+   :start-at: # Open script files
-    protocol file
+   :end-before: '''.splitlines()))
-    ext sh,command,tool
-    action launch --hold --type=os-window kitty +shebang $FILE_PATH {SHELL}
-
-    # Open shell specific script files
-    protocol file
-    ext fish,bash,zsh
-    action launch --hold --type=os-window kitty +shebang $FILE_PATH __ext__
-
-    # Open directories
-    protocol file
-    mime inode/directory
-    action launch --type=os-window --cwd $FILE_PATH
-
-    # Open text files without fragments in the editor
-    protocol file
-    mime text/*
-    action launch --type=os-window $EDITOR $FILE_PATH
-
-    # Open image files with icat
-    protocol file
-    mime image/*
-    action launch --type=os-window kitty +kitten icat --hold $FILE_PATH
-
-    # Open ssh URLs with ssh command
-    protocol ssh
-    action launch --type=os-window ssh $URL

docs/overview.rst

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

docs/performance.rst

@@ -2,30 +2,31 @@ Performance
 ===================
 
 The main goals for |kitty| performance are user perceived latency while typing
-and "smoothness" while scrolling as well as CPU usage. |kitty| tries hard to find
+and "smoothness" while scrolling as well as CPU usage. |kitty| tries hard to
-an optimum balance for these. To that end it keeps a cache of each rendered
+find an optimum balance for these. To that end it keeps a cache of each rendered
-glyph in video RAM so that font rendering is not a bottleneck.  Interaction
+glyph in video RAM so that font rendering is not a bottleneck. Interaction with
-with child programs takes place in a separate thread from rendering, to improve
+child programs takes place in a separate thread from rendering, to improve
 smoothness.
 
-There are two parameters you can tune to adjust the performance. :opt:`repaint_delay`
+There are two config options you can tune to adjust the performance,
-and :opt:`input_delay`. These control the artificial delays introduced into the
+:opt:`repaint_delay` and :opt:`input_delay`. These control the artificial delays
-render loop to reduce CPU usage. See :ref:`conf-kitty-performance` for details.
+introduced into the render loop to reduce CPU usage. See
-See also the :opt:`sync_to_monitor` option to further decrease latency at the cost
+:ref:`conf-kitty-performance` for details. See also the :opt:`sync_to_monitor`
-of some `tearing <https://en.wikipedia.org/wiki/Screen_tearing>`_ while scrolling.
+option to further decrease latency at the cost of some `screen tearing
+<https://en.wikipedia.org/wiki/Screen_tearing>`__ while scrolling.
 
-You can generate detailed per-function performance data using `gperftools
+You can generate detailed per-function performance data using
-<https://github.com/gperftools/gperftools>`_. Build |kitty| with `make
+`gperftools <https://github.com/gperftools/gperftools>`__. Build |kitty| with
-profile`. Run kitty and perform the task you want to analyse, for example,
+``make profile``. Run kitty and perform the task you want to analyse, for
-scrolling a large file with `less`. After you quit, function call statistics
+example, scrolling a large file with :program:`less`. After you quit, function
-will be printed to `stdout` and you can use tools like *kcachegrind* for more
+call statistics will be printed to STDOUT and you can use tools like
-detailed analysis.
+*KCachegrind* for more detailed analysis.
 
-Here are some CPU usage numbers for the task of scrolling a file continuously
+Here are some CPU usage numbers for the task of scrolling a file continuously in
-in less.  The CPU usage is for the terminal process and X together and is
+:program:`less`. The CPU usage is for the terminal process and X together and is
-measured using htop.  The measurements are taken at the same font and window
+measured using :program:`htop`. The measurements are taken at the same font and
-size for all terminals on a ``Intel(R) Core(TM) i7-4820K CPU @ 3.70GHz`` CPU
+window size for all terminals on a ``Intel(R) Core(TM) i7-4820K CPU @ 3.70GHz``
-with a ``Advanced Micro Devices, Inc. [AMD/ATI] Cape Verde XT [Radeon HD
+CPU with a ``Advanced Micro Devices, Inc. [AMD/ATI] Cape Verde XT [Radeon HD
 7770/8760 / R7 250X]`` GPU.
 
 ==============   =========================
@@ -49,11 +50,11 @@ admittedly biased, eyes).
 
 .. note::
 
-    Some people have asked why kitty does not perform better than terminal XXX in
+    Some people have asked why kitty does not perform better than terminal XXX
-    the test of sinking large amounts of data, such as catting a large text
+    in the test of sinking large amounts of data, such as catting a large text
-    file. The answer is because this is not a goal for kitty. kitty
+    file. The answer is because this is not a goal for kitty. kitty deliberately
-    deliberately throttles input parsing and output rendering to minimize
+    throttles input parsing and output rendering to minimize resource usage
-    resource usage while still being able to sink output faster than any real
+    while still being able to sink output faster than any real world program can
-    world program can produce it. Reducing CPU usage, and hence battery drain
+    produce it. Reducing CPU usage, and hence battery drain while achieving
-    while achieving instant response times and smooth scrolling to a human eye
+    instant response times and smooth scrolling to a human eye is a far more
-    is a far more important goal.
+    important goal.

docs/protocol-extensions.rst

@@ -1,23 +1,24 @@
 Terminal protocol extensions
 ===================================
 
-|kitty| has extensions to the legacy terminal protocol, to enable advanced features.
+|kitty| has extensions to the legacy terminal protocol, to enable advanced
-These are typically in the form of new or re-purposed escape codes. While these
+features. These are typically in the form of new or re-purposed escape codes.
-extensions are currently |kitty| specific, it would be nice to get some of them
+While these extensions are currently |kitty| specific, it would be nice to get
-adopted more broadly, to push the state of terminal emulators forward.
+some of them adopted more broadly, to push the state of terminal emulators
+forward.
 
 The goal of these extensions is to be as small and unobtrusive as possible,
-while filling in some gaps in the existing xterm protocol. In particular, one
+while filling in some gaps in the existing xterm protocol. In particular, one of
-of the goals of this specification is explicitly not to "re-imagine" the tty.
+the goals of this specification is explicitly not to "re-imagine" the TTY. The
-The tty should remain what it is -- a device for efficiently processing text
+TTY should remain what it is -- a device for efficiently processing text
 received as a simple byte stream. Another objective is to only move the minimum
-possible amount of extra functionality into the terminal program itself. This
+possible amount of extra functionality into the terminal program itself. This is
-is to make it as easy to implement these protocol extensions as possible,
+to make it as easy to implement these protocol extensions as possible, thereby
-thereby hopefully encouraging their widespread adoption.
+hopefully encouraging their widespread adoption.
 
-If you wish to discuss these extensions, propose additions/changes to them
+If you wish to discuss these extensions, propose additions or changes to them,
-please do so by opening issues in the `GitHub
+please do so by opening issues in the `GitHub bug tracker
-<https://github.com/kovidgoyal/kitty/issues>`_ bug tracker.
+<https://github.com/kovidgoyal/kitty/issues>`__.
 
 
 .. toctree::

docs/quickstart.rst

@@ -9,9 +9,9 @@ Quickstart
    binary
    build
 
-Pre-built binaries of |kitty| are available for both macOS and Linux.
+Pre-built binaries of |kitty| are available for both macOS and Linux. See the
-See the :doc:`binary install instructions </binary>`. You can also
+:doc:`binary install instructions </binary>`. You can also :doc:`build from
-:doc:`build from source </build>`.
+source </build>`.
 
 Additionally, you can use your favorite package manager to install the |kitty|
 package, but note that some Linux distribution packages are woefully outdated.
@@ -25,4 +25,4 @@ and Linux.
 See :doc:`Configuring kitty <conf>` for help on configuring |kitty| and
 :doc:`Invocation <invocation>` for the command line arguments |kitty| supports.
 
-For a tour of kitty's design and features, see the :doc:`/overview`.
+For a tour of kitty's design and features, see the :doc:`overview`.

docs/rc_protocol.rst

@@ -7,34 +7,74 @@ form::
 
     <ESC>P@kitty-cmd<JSON object><ESC>\
 
-Where ``<ESC>`` is the byte ``0x1b``. The JSON object has the form::
+Where ``<ESC>`` is the byte ``0x1b``. The JSON object has the form:
+
+.. code-block:: json
 
     {
         "cmd": "command name",
-        "version": <kitty version>,
+        "version": "<kitty version>",
-        "no_response": <Optional Boolean>,
+        "no_response": "<Optional Boolean>",
-        "payload": <Optional JSON object>,
+        "payload": "<Optional JSON object>"
     }
 
-The ``version`` above is an array of the form :code:`[0, 14, 2]`. If you are developing a
+The ``version`` above is an array of the form :code:`[0, 14, 2]`. If you are
-standalone client, use the kitty version that you are developing against. Using
+developing a standalone client, use the kitty version that you are developing
-a version greater than the version of the kitty instance you are talking to,
+against. Using a version greater than the version of the kitty instance you are
-will cause a failure.
+talking to, will cause a failure.
 
 Set ``no_response`` to ``true`` if you don't want a response from kitty.
 
-The optional payload is a JSON object that is specific to the actual command being sent.
+The optional payload is a JSON object that is specific to the actual command
-The fields in the object for every command are documented below.
+being sent. The fields in the object for every command are documented below.
 
 As a quick example showing how easy to use this protocol is, we will implement
-the ``@ ls`` command from the shell using only shell tools. First, run kitty
+the ``@ ls`` command from the shell using only shell tools.
-as::
+
+First, run kitty as::
 
     kitty -o allow_remote_control=socket-only --listen-on unix:/tmp/test
 
 Now, in a different terminal, you can get the pretty printed ``@ ls`` output
 with the following command line::
 
-    echo -en '\eP@kitty-cmd{"cmd":"ls","version":[0,14,2]}\e\' | socat - unix:/tmp/test | awk '{ print substr($0, 13, length($0) - 14) }' | jq -c '.data | fromjson' | jq .
+    echo -en '\eP@kitty-cmd{"cmd":"ls","version":[0,14,2]}\e\\' | socat - unix:/tmp/test | awk '{ print substr($0, 13, length($0) - 14) }' | jq -c '.data | fromjson' | jq .
+
+.. _rc_crypto:
+
+Encrypted communication
+--------------------------
+
+.. versionadded:: 0.26.0
+
+When using the :opt:`remote_control_password` option communication to the
+terminal is encrypted to keep the password secure. A public key is used from
+the :envvar:`KITTY_PUBLIC_KEY` environment variable. Currently, only one
+encryption protocol is supported. The protocol number is present in
+:envvar:`KITTY_PUBLIC_KEY` as ``1``. The key data in this environment variable
+is :rfc:`Base-85 <1924>` encoded.  The algorithm used is `Elliptic Curve Diffie
+Helman <https://en.wikipedia.org/wiki/Elliptic-curve_Diffie–Hellman>`__ with
+the `X25519 curve <https://en.wikipedia.org/wiki/Curve25519>`__. A time based
+nonce is used to minimise replay attacks. The original JSON command has the
+fields: ``password`` and ``timestamp`` added. The timestamp is the number of
+nanoseconds since the epoch, excluding leap seconds. Commands with a timestamp
+more than 5 minutes from the current time are rejected. The command is then
+encrypted using AES-256-GCM in authenticated encryption mode, with a symmetric
+key that is derived from the ECDH key-pair by running the shared secret through
+SHA-256 hashing, once.  An IV of at least 96 bits of CSPRNG data is used. The
+tag for authenticated encryption **must** be at least 128 bits long.  The tag
+**must** authenticate only the value of the ``encrypted`` field. A new command
+is created and transmitted that contains the fields:
+
+.. code-block:: json
+
+    {
+        "version": "<kitty version>",
+        "iv": "base85 encoded IV",
+        "tag": "base85 encoded AEAD tag",
+        "pubkey": "base85 encoded ECDH public key of sender",
+        "encrypted": "The original command encrypted and base85 encoded"
+    }
+
 
 .. include:: generated/rc.rst

docs/remote-control.rst

@@ -4,9 +4,12 @@ Control kitty from scripts
 .. highlight:: sh
 
 |kitty| can be controlled from scripts or the shell prompt. You can open new
-windows, send arbitrary text input to any window, name windows and tabs, etc.
+windows, send arbitrary text input to any window, change the title of windows
+and tabs, etc.
+
 Let's walk through a few examples of controlling |kitty|.
 
+
 Tutorial
 ------------
 
@@ -14,50 +17,52 @@ Start by running |kitty| as::
 
     kitty -o allow_remote_control=yes -o enabled_layouts=tall
 
-In order for control to work, :opt:`allow_remote_control` must be enabled in
+In order for control to work, :opt:`allow_remote_control` or
-:file:`kitty.conf`. Here we turn it on explicitly at the command line.
+:opt:`remote_control_password` must be enabled in :file:`kitty.conf`. Here we
+turn it on explicitly at the command line.
 
 Now, in the new |kitty| window, enter the command::
 
     kitty @ launch --title Output --keep-focus cat
 
-This will open a new window, running the ``cat`` program that will appear next
+This will open a new window, running the :program:`cat` program that will appear
-to the current window.
+next to the current window.
 
 Let's send some text to this new window::
 
     kitty @ send-text --match cmdline:cat Hello, World
 
-This will make ``Hello, World`` show up in the window running the ``cat`` program.
+This will make ``Hello, World`` show up in the window running the :program:`cat`
-The :option:`kitty @ send-text --match` option is very powerful, it allows selecting windows by their
+program. The :option:`kitty @ send-text --match` option is very powerful, it
-titles, the command line of the program running in the window, the working
+allows selecting windows by their titles, the command line of the program
-directory of the program running in the window, etc.  See ``kitty @ send-text
+running in the window, the working directory of the program running in the
---help`` for details.
+window, etc. See :ref:`kitty @ send-text --help <at-send-text>` for details.
 
 More usefully, you can pipe the output of a command running in one window to
 another window, for example::
 
-    ls | kitty @ send-text --match title:Output --stdin
+    ls | kitty @ send-text --match 'title:^Output' --stdin
 
-This will show the output of ls in the output window instead of the current
+This will show the output of :program:`ls` in the output window instead of the
-window. You can use this technique to, for example, show the output of running
+current window. You can use this technique to, for example, show the output of
-``make`` in your editor in a different window. The possibilities are endless.
+running :program:`make` in your editor in a different window. The possibilities
+are endless.
 
 You can even have things you type show up in a different window. Run::
 
-    kitty @ send-text --match title:Output --stdin
+    kitty @ send-text --match 'title:^Output' --stdin
 
 And type some text, it will show up in the output window, instead of the current
-window. Type ``Ctrl+D`` when you are ready to stop.
+window. Type :kbd:`Ctrl+D` when you are ready to stop.
 
 Now, let's open a new tab::
 
    kitty @ launch --type=tab --tab-title "My Tab" --keep-focus bash
 
 This will open a new tab running the bash shell with the title "My Tab".
-We can change the title of the tab with::
+We can change the title of the tab to "New Title" with::
 
-   kitty @ set-tab-title --match title:My  New Title
+   kitty @ set-tab-title --match 'title:^My' New Title
 
 Let's change the title of the current tab::
 
@@ -65,79 +70,196 @@ Let's change the title of the current tab::
 
 Now lets switch to the newly opened tab::
 
-   kitty @ focus-tab --match title:New
+   kitty @ focus-tab --match 'title:^New'
 
 Similarly, to focus the previously opened output window (which will also switch
 back to the old tab, automatically)::
 
-   kitty @ focus-window --match title:Output
+   kitty @ focus-window --match 'title:^Output'
 
 You can get a listing of available tabs and windows, by running::
 
    kitty @ ls
 
 This outputs a tree of data in JSON format. The top level of the tree is all
-operating system kitty windows. Each OS window has an id and a list of tabs.
+:term:`OS windows <os_window>`. Each OS window has an id and a list of
-Each tab has its own id, a title and a list of windows. Each window has an id,
+:term:`tabs <tab>`. Each tab has its own id, a title and a list of :term:`kitty
-title, current working directory, process id (PID) and command-line of the
+windows <window>`. Each window has an id, title, current working directory,
-process running in the window. You can use this information with :option:`kitty @ focus-window --match`
+process id (PID) and command-line of the process running in the window. You can
-to control individual windows.
+use this information with :option:`kitty @ focus-window --match` to control
+individual windows.
 
-As you can see, it is very easy to control |kitty| using the
+As you can see, it is very easy to control |kitty| using the ``kitty @``
-``kitty @`` messaging system. This tutorial touches only the
+messaging system. This tutorial touches only the surface of what is possible.
-surface of what is possible. See ``kitty @ --help`` for more details.
+See ``kitty @ --help`` for more details.
 
-Note that in the example's above, ``kitty @`` messaging works only when run inside a |kitty| window,
+In the example's above, ``kitty @`` messaging works only when run
-not anywhere. But, within a |kitty| window it even works over SSH. If you want to control
+inside a |kitty| window, not anywhere. But, within a |kitty| window it even
-|kitty| from programs/scripts not running inside a |kitty| window, you have to implement a couple of
+works over SSH. If you want to control |kitty| from programs/scripts not running
-extra steps. First start |kitty| as::
+inside a |kitty| window, see the section on :ref:`using a socket for remote control <rc_via_socket>`
+below.
+
+
+Note that if all you want to do is run a single |kitty| "daemon" and have
+subsequent |kitty| invocations appear as new top-level windows, you can use the
+simpler :option:`kitty --single-instance` option, see ``kitty --help`` for that.
+
+
+.. _rc_via_socket:
+
+Remote control via a socket
+--------------------------------
+First, start |kitty| as::
 
     kitty -o allow_remote_control=yes --listen-on unix:/tmp/mykitty
 
-The :option:`kitty --listen-on` option tells |kitty| to listen for control messages at the
+The :option:`kitty --listen-on` option tells |kitty| to listen for control
-specified path. See ``kitty --help`` for details. Now you can control this
+messages at the specified UNIX-domain socket. See ``kitty --help`` for details.
-instance of |kitty| using the :option:`kitty @ --to` command line argument to ``kitty @``. For example::
+Now you can control this instance of |kitty| using the :option:`kitty @ --to`
+command line argument to ``kitty @``. For example::
 
     kitty @ --to unix:/tmp/mykitty ls
 
 
-Note that if all you want to do is run a single |kitty| "daemon" and have subsequent
-|kitty| invocations appear as new top-level windows, you can use the simpler :option:`kitty --single-instance`
-option, see ``kitty --help`` for that.
-
 The builtin kitty shell
 --------------------------
 
-You can explore the |kitty| command language more easily using the builtin |kitty|
+You can explore the |kitty| command language more easily using the builtin
-shell. Run ``kitty @`` with no arguments and you will be dropped into the |kitty|
+|kitty| shell. Run ``kitty @`` with no arguments and you will be dropped into
-shell with completion for |kitty| command names and options.
+the |kitty| shell with completion for |kitty| command names and options.
 
 You can even open the |kitty| shell inside a running |kitty| using a simple
 keyboard shortcut (:sc:`kitty_shell` by default).
 
 .. note:: This has the added advantage that you don't need to use
-   ``allow_remote_control`` to make it work.
+   :opt:`allow_remote_control` to make it work.
 
 
 Allowing only some windows to control kitty
 ----------------------------------------------
 
-If you do not want to allow all programs running in |kitty| to control it, you can selectively
+If you do not want to allow all programs running in |kitty| to control it, you
-enable remote control for only some |kitty| windows. Simply create a shortcut
+can selectively enable remote control for only some |kitty| windows. Simply
-such as::
+create a shortcut such as::
 
     map ctrl+k launch --allow-remote-control some_program
 
 Then programs running in windows created with that shortcut can use ``kitty @``
 to control kitty. Note that any program with the right level of permissions can
-still write to the pipes of any other program on the same computer and
+still write to the pipes of any other program on the same computer and therefore
-therefore can control |kitty|. It can, however, be useful to block programs
+can control |kitty|. It can, however, be useful to block programs running on
-running on other computers (for example, over ssh) or as other users.
+other computers (for example, over SSH) or as other users.
 
-.. note:: You dont need ``allow_remote_control`` to make this work as it is
+.. note:: You don't need :opt:`allow_remote_control` to make this work as it is
    limited to only programs running in that specific window. Be careful with
    what programs you run in such windows, since they can effectively control
-   kitty, as if you were running with ``allow_remote_control`` turned on.
+   kitty, as if you were running with :opt:`allow_remote_control` turned on.
+
+    You can further restrict what is allowed in these windows by using
+    :option:`kitty @ launch --remote-control-password`.
+
+
+Fine grained permissions for remote control
+----------------------------------------------
+
+.. versionadded:: 0.26.0
+
+The :opt:`allow_remote_control` option discussed so far is a blunt
+instrument, granting the ability to any program running on your computer
+or even on remote computers via SSH the ability to use remote control.
+
+You can instead define remote control passwords that can be used to grant
+different levels of control to different places. You can even write your
+own script to decide which remote control requests are allowed. This is
+done using the :opt:`remote_control_password` option in :file:`kitty.conf`.
+Set :opt:`allow_remote_control` to :code:`password` to use this feature.
+Let's see some examples:
+
+.. code-block:: conf
+
+   remote_control_password "control colors" get-colors set-colors
+
+Now, using this password, you can, in scripts run the command::
+
+    kitty @ --password="control colors" set-colors background=red
+
+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-password` to avoid having to type it repeatedly.
+See :option:`kitty @ --password-file` and :option:`kitty @ --password-env`.
+
+The :opt:`remote_control_password` can be specified multiple times to create
+different passwords with different capabilities. Run the following to get a
+list of all action names::
+
+    kitty @ --help
+
+You can even use glob patterns to match action names, for example:
+
+.. code-block:: conf
+
+   remote_control_password "control colors" *-colors
+
+If no action names are specified, all actions are allowed.
+
+If ``kitty @`` is run with a password that is not present in
+:file:`kitty.conf`, then kitty will interactively prompt the user to allow or
+disallow the remote control request. The user can choose to allow or disallow
+either just that request or all requests using that password. The user's
+decision is remembered for the duration of that kitty instance.
+
+.. note::
+   For password based authentication to work over SSH, you must pass the
+   :envvar:`KITTY_PUBLIC_KEY` environment variable to the remote host. The
+   :doc:`ssh kitten <kittens/ssh>` does this for you automatically. When
+   using a password, :ref:`rc_crypto` is used to ensure the password
+   is kept secure. This does mean that using password based authentication
+   is slower as the entire command is encrypted before transmission. This
+   can be noticeable when using a command like ``kitty @ set-background-image``
+   which transmits large amounts of image data. Also, the clock on the remote
+   system must match (within a few minutes) the clock on the local system.
+   kitty uses a time based nonce to minimise the potential for replay attacks.
+
+.. _rc_custom_auth:
+
+Customizing authorization with your own program
+____________________________________________________________
+
+If the ability to control access by action names is not fine grained enough,
+you can define your own Python script to examine every remote control command
+and allow/disallow it. To do so create a file in the kitty configuration
+directory, :file:`~/.config/kitty/my_rc_auth.py` and add the following
+to :file:`kitty.conf`:
+
+.. code-block:: conf
+
+    remote_control_password "testing custom auth" my_rc_auth.py
+
+:file:`my_rc_auth.py` should define a :code:`is_cmd_allowed` function
+as shown below:
+
+.. code-block:: py
+
+    def is_cmd_allowed(pcmd, window, from_socket, extra_data):
+        cmd_name = pcmd['cmd']  # the name of the command
+        cmd_payload = pcmd['payload']  # the arguments to the command
+        # examine the cmd_name and cmd_payload and return True to allow
+        # the command or False to disallow it. Return None to have no
+        # effect on the command.
+
+        # The command payload will vary from command to command, see
+        # the rc protocol docs for details. Below is an example of
+        # restricting the launch command to allow only running the
+        # default shell.
+
+        if cmd_name != 'launch':
+            return None
+        if cmd_payload.get('args') or cmd_payload.get('env') or cmd_payload.get('copy_cmdline') or cmd_payload.get('copy_env'):
+            return False
+        # prints in this function go to the parent kitty process STDOUT
+        print('Allowing launch command:', cmd_payload)
+        return True
 
 
 .. _rc_mapping:
@@ -148,15 +270,21 @@ Mapping key presses to remote control commands
 If you wish to trigger a remote control command easily with just a keypress,
 you can map it in :file:`kitty.conf`. For example::
 
-    map F1 remote_control set-spacing margin=30
+    map f1 remote_control set-spacing margin=30
 
-Then pressing the :kbd:`F1` key will set the active window margins to 30.
+Then pressing the :kbd:`F1` key will set the active window margins to
-The syntax for what follows :code:`remote_control` is exactly the same
+:code:`30`. The syntax for what follows :ac:`remote_control` is exactly the same
 as the syntax for what follows :code:`kitty @` above.
 
-.. note:: You do not need ``allow_remote_control`` to use these mappings,
+If you wish to ignore errors from the command, prefix the command with an
-   as they are not actual remote programs, but are simply a way to resuse
+``!``. For example, the following will not return an error when no windows
-   the remote control infrastructure via keybings.
+are matched::
+
+    map f1 remote_control !focus-window --match XXXXXX
+
+.. 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 resuse the
+   remote control infrastructure via keybings.
 
 
 Broadcasting what you type to all kitty windows
@@ -166,17 +294,36 @@ As a simple illustration of the power of remote control, lets
 have what we type sent to all open kitty windows. To do that define the
 following mapping in :file:`kitty.conf`::
 
-    map F1 launch --allow-remote-control kitty +kitten broadcast
+    map f1 launch --allow-remote-control kitty +kitten broadcast
 
-Now press, F1 and start typing, what you type will be sent to all windows,
+Now press :kbd:`F1` and start typing, what you type will be sent to all windows,
 live, as you type it.
 
 
 The remote control protocol
 -----------------------------------------------
 
-If you wish to develop your own client to talk to |kitty|, you
+If you wish to develop your own client to talk to |kitty|, you can use the
-can use the :doc:`protocol specification <rc_protocol>`.
+:doc:`remote control protocol specification <rc_protocol>`.
+
+
+.. _search_syntax:
+
+Matching windows and tabs
+----------------------------
+
+Many remote control operations operate on windows or tabs. To select these, the
+:code:`--match` option is often used. This allows matching using various
+sophisticated criteria such as title, ids, cmdlines, etc. These criteria are
+expressions of the form :code:`field:query`. Where :italic:`field` is the field
+against which to match and :italic:`query` is the expression to match. They can
+be further combined using Boolean operators, best illustrated with some
+examples::
+
+    title:"My special window" or id:43
+    title:bash and env:USER=kovid
+    not id:1
+    (id:2 or id:3) and title:something
 
 .. toctree::
    :hidden:

docs/shell-integration.rst

@@ -4,8 +4,8 @@ Shell integration
 -------------------
 
 kitty has the ability to integrate closely within common shells, such as `zsh
-<https://www.zsh.org/>`_, `fish <https://fishshell.com>`_ and `bash
+<https://www.zsh.org/>`__, `fish <https://fishshell.com>`__ and `bash
-<https://www.gnu.org/software/bash/>`_ to enable features such as jumping to
+<https://www.gnu.org/software/bash/>`__ to enable features such as jumping to
 previous prompts in the scrollback, viewing the output of the last command in
 :program:`less`, using the mouse to move the cursor while editing prompts, etc.
 
@@ -22,7 +22,7 @@ Features
 
 * Click with the mouse anywhere in the current command to move the cursor there
 
-* Hold :kbd:`ctrl+shift` and right-click on any command output in the scrollback
+* Hold :kbd:`Ctrl+Shift` and right-click on any command output in the scrollback
   to view it in a pager
 
 * The current working directory or the command being executed are automatically
@@ -30,20 +30,25 @@ Features
 
 * The text cursor is changed to a bar when editing commands at the shell prompt
 
+* :ref:`clone_shell` with all environment variables and the working directory
+  copied
+
+* :ref:`Edit files in new kitty windows <edit_file>` even over SSH
+
 * Glitch free window resizing even with complex prompts. Achieved by erasing
   the prompt on resize and allowing the shell to redraw it cleanly.
 
 * Sophisticated completion for the :program:`kitty` command in the shell.
 
 * When confirming a quit command if a window is sitting at a shell prompt,
-  it is optionally, not counted (see :opt:`confirm_os_window_close`)
+  it is not counted (for details, see :opt:`confirm_os_window_close`)
 
 
 Configuration
 ---------------
 
 Shell integration is controlled by the :opt:`shell_integration` option. By
-default, all shell integration is enabled. Individual features can be turned
+default, all integration features are enabled. Individual features can be turned
 off or it can be disabled entirely as well. The :opt:`shell_integration` option
 takes a space separated list of keywords:
 
@@ -53,19 +58,29 @@ disabled
     :ref:`manual integration <manual_shell_integration>`.
 
 no-rc
-    Do not modify the shell's launch environment to enable integration. Useful if you prefer
+    Do not modify the shell's launch environment to enable integration. Useful
-    to load the kitty shell integration code yourself, either as part of
+    if you prefer to load the kitty shell integration code yourself, either as
-    :ref:`manually integration <manual_shell_integration>` or because you have
+    part of :ref:`manually integration <manual_shell_integration>` or because
-    some other software that sets up shell integration.
+    you have some other software that sets up shell integration.
-    This will still set the :envvar:`KITTY_SHELL_INTEGRATION` environment variable when kitty runs the shell.
+    This will still set the :envvar:`KITTY_SHELL_INTEGRATION` environment
+    variable when kitty runs the shell.
 
 no-cursor
-    Turn off changing of the text cursor to a bar when editing text
+    Turn off changing of the text cursor to a bar when editing shell command
+    line.
 
 no-title
     Turn off setting the kitty window/tab title based on shell state.
-    Note that for the ``fish`` shell kitty relies on fish's native title
+    Note that for the fish shell kitty relies on fish's native title setting
-    setting functionality instead.
+    functionality instead.
+
+no-cwd
+    Turn off reporting the current working directory. This is used to allow
+    :ac:`new_window_with_cwd` and similar to open windows logged into remote
+    machines using the :doc:`ssh kitten <kittens/ssh>` automatically with the
+    same working directory as the current window.
+    Note that for the fish shell this will not disable its built-in current
+    working directory reporting.
 
 no-prompt-mark
     Turn off marking of prompts. This disables jumping to prompt, browsing
@@ -73,16 +88,16 @@ no-prompt-mark
 
 no-complete
     Turn off completion for the kitty command.
-    Note that for the ``fish`` shell this does not take effect, since fish
+    Note that for the fish shell this does not take effect, since fish already
-    already comes with a kitty completion script.
+    comes with a kitty completion script.
 
 
 More ways to browse command output
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 You can add further key and mouse bindings to browse the output of commands
-easily. For example to select the output of a command by right clicking the mouse
+easily. For example to select the output of a command by right clicking the
-on the output, define the following in :file:`kitty.conf`:
+mouse on the output, define the following in :file:`kitty.conf`:
 
 .. code:: conf
 
@@ -93,8 +108,8 @@ to be copied.
 
 The feature to jump to previous prompts (
 :sc:`scroll_to_previous_prompt` and :sc:`scroll_to_next_prompt`) and mouse
-actions (:ac:`mouse_select_command_output` and :ac:`mouse_show_command_output`) can
+actions (:ac:`mouse_select_command_output` and :ac:`mouse_show_command_output`)
-be integrated with browsing command output as well. For example, define the
+can be integrated with browsing command output as well. For example, define the
 following mapping in :file:`kitty.conf`:
 
 .. code:: conf
@@ -126,42 +141,41 @@ How it works
 -----------------
 
 At startup, kitty detects if the shell you have configured (either system wide
-or in kitty.conf) is a supported shell. If so, kitty injects some shell specific
+or the :opt:`shell` option in :file:`kitty.conf`) is a supported shell. If so,
-code into the shell, to enable shell integration. How it does so varies for
+kitty injects some shell specific code into the shell, to enable shell
-different shells.
+integration. How it does so varies for different shells.
 
 
 .. tab:: zsh
 
-   For zsh, kitty sets the ``ZDOTDIR`` environment variable to make zsh load
+   For zsh, kitty sets the :envvar:`ZDOTDIR` environment variable to make zsh
-   kitty's :file:`.zshenv` which restores the original value of ``ZDOTDIR``
+   load kitty's :file:`.zshenv` which restores the original value of
-   and sources the original :file:`.zshenv`. It then loads the shell integration code.
+   :envvar:`ZDOTDIR` and sources the original :file:`.zshenv`. It then loads
-   The remainder of zsh's startup process proceeds as normal.
+   the shell integration code. The remainder of zsh's startup process proceeds
+   as normal.
 
 .. tab:: fish
 
     For fish, to make it automatically load the integration code provided by
     kitty, the integration script directory path is prepended to the
-    ``XDG_DATA_DIRS`` environment variable. This is only applied to the fish
+    :envvar:`XDG_DATA_DIRS` environment variable. This is only applied to the
-    process and will be cleaned up by the integration script after startup. No files
+    fish process and will be cleaned up by the integration script after startup.
-    are added or modified.
+    No files are added or modified.
 
 .. tab:: bash
 
     For bash, kitty starts bash in POSIX mode, using the environment variable
-    ``ENV`` to load the shell integrtion script. This prevents bash from
+    :envvar:`ENV` to load the shell integration script. This prevents bash from
     loading any startup files itself. The loading of the startup files is done
-    by the integration script, after disabling POSIX mode. From the
+    by the integration script, after disabling POSIX mode. From the perspective
-    perspective of those scripts there should be no difference to running
+    of those scripts there should be no difference to running vanilla bash.
-    vanilla bash.
 
 
 Then, when launching the shell, kitty sets the environment variable
 :envvar:`KITTY_SHELL_INTEGRATION` to the value of the :opt:`shell_integration`
 option. The shell integration code reads the environment variable, turns on the
 specified integration functionality and then unsets the variable so as to not
-pollute the system. This has the nice effect that the changes to the shell's rc
+pollute the system.
-files become no-ops when running the shell in anything other than kitty itself.
 
 The actual shell integration code uses hooks provided by each shell to send
 special escape codes to kitty, to perform the various tasks. You can see the
@@ -194,13 +208,97 @@ code used for each shell below:
    </details>
 
 
+Shell integration over SSH
+----------------------------
+
+The easiest way to have shell integration work when SSHing into remote systems
+is to use the :doc:`ssh kitten <kittens/ssh>`. Simply run::
+
+    kitty +kitten ssh hostname
+
+And, by magic, you will be logged into the remote system with fully functional
+shell integration. Alternately, you can :ref:`setup shell integration manually
+<manual_shell_integration>`, by copying the kitty shell integration scripts to
+the remote server and editing the shell rc files there, as described below.
+
+
+.. _clone_shell:
+
+Clone the current shell into a new window
+-----------------------------------------------
+
+You can clone the current shell into a new kitty window by simply running the
+:command:`clone-in-kitty` command, for example:
+
+.. code-block:: sh
+
+    clone-in-kitty
+    clone-in-kitty --type=tab
+    clone-in-kitty --title "I am a clone"
+
+This will open a new window running a new shell instance but with all
+environment variables and the current working directory copied. This even works
+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 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
+--copy-env>`, :option:`--stdin-source <launch --stdin-source>`,
+:option:`--marker <launch --marker>` and :option:`--watcher <launch --watcher>`.
+
+:command:`clone-in-kitty` can be configured to source arbitrary code in the
+cloned window using environment variables. It will automatically clone virtual
+environments created by the :link:`Python venv module
+<https://docs.python.org/3/library/venv.html>` or :link:`Conda
+<https://conda.io/>`. In addition, setting the
+env var :envvar:`KITTY_CLONE_SOURCE_CODE` to some shell code will cause that
+code to be run in the cloned window with :code:`eval`. Similarly, setting
+:envvar:`KITTY_CLONE_SOURCE_PATH` to the path of a file will cause that file to
+be sourced in the cloned window. This can be controlled by
+:opt:`clone_source_strategies`.
+
+:command:`clone-in-kitty` works by asking the shell to serialize its internal
+state (mainly CWD and env vars) and this state is transmitted to kitty and
+restored by the shell integration scripts in the cloned window.
+
+
+.. _edit_file:
+
+Edit files in new kitty windows even over SSH
+------------------------------------------------
+
+.. code-block:: sh
+
+   edit-in-kitty myfile.txt
+   edit-in-kitty --type tab --title "Editing My File" myfile.txt
+   # open myfile.txt at line 75 (works with vim, neovim, emacs, nano, micro)
+   edit-in-kitty +75 myfile.txt
+
+The :command:`edit-in-kitty` command allows you to seamlessly edit files
+in your default :opt:`editor` in new kitty windows. This works even over
+SSH (if you use the :doc:`ssh kitten <kittens/ssh>`), allowing you
+to easily edit remote files in your local editor with all its bells and
+whistles.
+
+The :command:`edit-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. 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.
+
+
 .. _manual_shell_integration:
 
 Manual shell integration
 ----------------------------
 
 The automatic shell integration is designed to be minimally intrusive, as such
-it wont work for sub-shells, terminal multiplexers, containers, remote systems, etc.
+it wont work for sub-shells, terminal multiplexers, containers, etc.
 For such systems, you should setup manual shell integration by adding some code
 to your shells startup files to load the shell integration script.
 
@@ -248,18 +346,17 @@ The value of :envvar:`KITTY_SHELL_INTEGRATION` is the same as that for
 completely, in which case simply do not set the
 :envvar:`KITTY_SHELL_INTEGRATION` variable at all.
 
-If you want this to work while SSHing into a remote system, then you will
+In a container, you will need to install the kitty shell integration scripts
-need to add some code to the snippets above to check if :envvar:`KITTY_INSTALLATION_DIR`
+and make sure the :envvar:`KITTY_INSTALLATION_DIR` environment variable is set
-is empty and if so to set it to some hard coded location with the shell
+to point to the location of the scripts.
-integration scripts that need to be copied onto the remote system.
-
 
 Integration with other shells
 -------------------------------
 
-There exist third-party integrations to use these features for various other shells:
+There exist third-party integrations to use these features for various other
+shells:
 
-* Jupyter console via a patch (:iss:`4475`)
+* Jupyter console and IPython via a patch (:iss:`4475`)
 * `xonsh <https://github.com/xonsh/xonsh/issues/4623>`__
 
 

docs/underlines.rst

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

docs/unscroll.rst

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

gen-config.py

@@ -1,4 +1,4 @@
-#!/usr/bin/env python
+#!./kitty/launcher/kitty +launch
 # License: GPLv3 Copyright: 2021, Kovid Goyal <kovid at kovidgoyal.net>
 
 
@@ -38,6 +38,8 @@ def main() -> None:
 
     from kittens.diff.options.definition import definition as kd
     write_output('kittens.diff', kd)
+    from kittens.ssh.options.definition import definition as sd
+    write_output('kittens.ssh', sd)
 
 
 if __name__ == '__main__':

glfw/cocoa_init.m

@@ -770,6 +770,11 @@ is_useful_apple_global_shortcut(int sc) {
     }
 }
 
+static bool
+is_apple_jis_layout_function_key(NSEvent *event) {
+    return [event keyCode] == 0x66 /* kVK_JIS_Eisu */ || [event keyCode] == 0x68 /* kVK_JIS_Kana */;
+}
+
 GLFWAPI GLFWapplicationshouldhandlereopenfun glfwSetApplicationShouldHandleReopen(GLFWapplicationshouldhandlereopenfun callback) {
     GLFWapplicationshouldhandlereopenfun previous = handle_reopen_callback;
     handle_reopen_callback = callback;
@@ -837,6 +842,14 @@ int _glfwPlatformInit(void)
                 last_keydown_shortcut_event.timestamp = [event timestamp];
                 return event;
             }
+            // check for JIS keyboard layout function keys
+            if (is_apple_jis_layout_function_key(event)) {
+                debug_key("keyDown triggerred JIS layout function key ignoring\n");
+                last_keydown_shortcut_event.virtual_key_code = [event keyCode];
+                last_keydown_shortcut_event.input_source_switch_modifiers = 0;
+                last_keydown_shortcut_event.timestamp = [event timestamp];
+                return event;
+            }
         }
         last_keydown_shortcut_event.virtual_key_code = 0xffff;
         NSWindow *kw = [NSApp keyWindow];

glfw/cocoa_window.m

@@ -29,6 +29,7 @@
 #include "internal.h"
 #include "../kitty/monotonic.h"
 
+#include <Availability.h>
 #include <float.h>
 #include <string.h>
 
@@ -1377,7 +1378,7 @@ is_ascii_control_char(char x) {
             if ([obj isKindOfClass:[NSURL class]]) {
                 NSURL *url = (NSURL*)obj;
                 if ([uri_list length] > 0) [uri_list appendString:@("\n")];
-                if (url.fileURL) [uri_list appendFormat:@("file://%s"), url.fileSystemRepresentation];
+                if (url.fileURL) [uri_list appendString:url.filePathURL.absoluteString];
                 else [uri_list appendString:url.absoluteString];
             } else if ([obj isKindOfClass:[NSString class]]) {
                 const char *text = [obj UTF8String];
@@ -1540,6 +1541,39 @@ void _glfwPlatformUpdateIMEState(_GLFWwindow *w, const GLFWIMEUpdateEvent *ev) {
     debug_key("\n\tdoCommandBySelector: (%s)\n", [NSStringFromSelector(selector) UTF8String]);
 }
 
+- (BOOL)isAccessibilityElement
+{
+    return YES;
+}
+
+- (BOOL)isAccessibilitySelectorAllowed:(SEL)selector
+{
+    if (selector == @selector(accessibilityRole) || selector == @selector(accessibilitySelectedText)) return YES;
+    return NO;
+}
+
+#if (TARGET_OS_OSX && __MAC_OS_X_VERSION_MIN_REQUIRED >= 101400)
+
+- (NSAccessibilityRole)accessibilityRole
+{
+    return NSAccessibilityTextAreaRole;
+}
+
+#endif
+
+- (NSString *)accessibilitySelectedText
+{
+    NSString *text = nil;
+    if (_glfw.callbacks.get_current_selection) {
+        char *s = _glfw.callbacks.get_current_selection();
+        if (s) {
+            text = [NSString stringWithUTF8String:s];
+            free(s);
+        }
+    }
+    return text;
+}
+
 @end
 // }}}
 
@@ -1731,7 +1765,11 @@ int _glfwPlatformCreateWindow(_GLFWwindow* window,
 
     if (!createNativeWindow(window, wndconfig, fbconfig))
         return false;
-    [window->ns.object setColorSpace:[NSColorSpace sRGBColorSpace]];
+    switch((GlfwCocoaColorSpaces)wndconfig->ns.color_space) {
+        case SRGB_COLORSPACE: [window->ns.object setColorSpace:[NSColorSpace sRGBColorSpace]]; break;
+        case DISPLAY_P3_COLORSPACE: [window->ns.object setColorSpace:[NSColorSpace displayP3ColorSpace]]; break;
+        case DEFAULT_COLORSPACE: break;
+    }
 
     if (ctxconfig->client != GLFW_NO_API)
     {
@@ -2475,28 +2513,45 @@ void _glfwPlatformSetClipboardString(const char* string)
     [pasteboard setString:@(string) forType:NSPasteboardTypeString];
 }
 
+void _glfwPlatformSetPrimarySelectionString(const char* string) {
+    (void)string;
+    // Apple doesnt have a primary selection
+}
+
+const char* _glfwPlatformGetPrimarySelectionString(void) { return ""; }
+
 const char* _glfwPlatformGetClipboardString(void)
 {
     NSPasteboard* pasteboard = [NSPasteboard generalPasteboard];
+    free(_glfw.ns.clipboardString); _glfw.ns.clipboardString = NULL;
 
-    if (![[pasteboard types] containsObject:NSPasteboardTypeString])
+    NSDictionary* options = @{NSPasteboardURLReadingFileURLsOnlyKey:@YES};
-    {
+    NSArray* objs = [pasteboard readObjectsForClasses:@[[NSURL class], [NSString class]] options:options];
-        _glfwInputError(GLFW_FORMAT_UNAVAILABLE,
+    if (objs) {
-                        "Cocoa: Failed to retrieve string from pasteboard");
+        const NSUInteger count = [objs count];
-        return NULL;
+        if (count) {
+            NSMutableString *path_list = [NSMutableString stringWithCapacity:4096];  // auto-released
+            NSMutableString *text_list = [NSMutableString stringWithCapacity:4096];  // auto-released
+            for (NSUInteger i = 0;  i < count;  i++) {
+                id obj = objs[i];
+                if ([obj isKindOfClass:[NSURL class]]) {
+                    NSURL *url = (NSURL*)obj;
+                    if (url.fileURL && url.fileSystemRepresentation) {
+                        if ([path_list length] > 0) [path_list appendString:@("\n")];
+                        [path_list appendString:@(url.fileSystemRepresentation)];
+                    }
+                } else if ([obj isKindOfClass:[NSString class]]) {
+                    if ([text_list length] > 0) [text_list appendString:@("\n")];
+                    [text_list appendString:obj];
+                }
+            }
+            const char *text = NULL;
+            if (path_list.length > 0) text = [path_list UTF8String];
+            else if (text_list.length > 0) text = [text_list UTF8String];
+            if (text) _glfw.ns.clipboardString = _glfw_strdup(text);
+        }
     }
-
+    if (!_glfw.ns.clipboardString) _glfwInputError(GLFW_PLATFORM_ERROR, "Cocoa: Failed to retrieve object from pasteboard");
-    NSString* object = [pasteboard stringForType:NSPasteboardTypeString];
-    if (!object)
-    {
-        _glfwInputError(GLFW_PLATFORM_ERROR,
-                        "Cocoa: Failed to retrieve object from pasteboard");
-        return NULL;
-    }
-
-    free(_glfw.ns.clipboardString);
-    _glfw.ns.clipboardString = _glfw_strdup([object UTF8String]);
-
     return _glfw.ns.clipboardString;
 }
 

glfw/context.c

@@ -396,15 +396,6 @@ bool _glfwRefreshContextAttribs(_GLFWwindow* window,
             window->context.release = GLFW_RELEASE_BEHAVIOR_FLUSH;
     }
 
-    // Clearing the front buffer to black to avoid garbage pixels left over from
-    // previous uses of our bit of VRAM
-    {
-        PFNGLCLEARPROC glClear = (PFNGLCLEARPROC)
-            window->context.getProcAddress("glClear");
-        glClear(GL_COLOR_BUFFER_BIT);
-        window->context.swapBuffers(window);
-    }
-
     glfwMakeContextCurrent((GLFWwindow*) previous);
     return true;
 }

glfw/egl_context.c

@@ -428,6 +428,8 @@ bool _glfwInitEGL(void)
         extensionSupportedEGL("EGL_KHR_get_all_proc_addresses");
     _glfw.egl.KHR_context_flush_control =
         extensionSupportedEGL("EGL_KHR_context_flush_control");
+    _glfw.egl.EXT_present_opaque =
+        extensionSupportedEGL("EGL_EXT_present_opaque");
 
     return true;
 }
@@ -598,6 +600,8 @@ bool _glfwCreateContextEGL(_GLFWwindow* window,
         if (_glfw.egl.KHR_gl_colorspace)
             setAttrib(EGL_GL_COLORSPACE_KHR, EGL_GL_COLORSPACE_SRGB_KHR);
     }
+    if (_glfw.egl.EXT_present_opaque)
+        setAttrib(EGL_PRESENT_OPAQUE_EXT, !fbconfig->transparent);
 
     setAttrib(EGL_NONE, EGL_NONE);
 

glfw/egl_context.h

@@ -160,11 +160,11 @@ typedef EGLSurface (EGLAPIENTRY * PFNEGLCREATEPLATFORMWINDOWSURFACEEXTPROC)(EGLD
 //
 typedef struct _GLFWcontextEGL
 {
-   EGLConfig        config;
+    EGLConfig        config;
-   EGLContext       handle;
+    EGLContext       handle;
-   EGLSurface       surface;
+    EGLSurface       surface;
 
-   void*            client;
+    void*            client;
 
 } _GLFWcontextEGL;
 
@@ -186,6 +186,7 @@ typedef struct _GLFWlibraryEGL
     bool            EXT_platform_base;
     bool            EXT_platform_x11;
     bool            EXT_platform_wayland;
+    bool            EXT_present_opaque;
     bool            ANGLE_platform_angle;
     bool            ANGLE_platform_angle_opengl;
     bool            ANGLE_platform_angle_d3d;

glfw/glfw3.h

@@ -512,6 +512,7 @@ typedef enum {
  *  GLFW_LOCK_KEY_MODS input mode is set.
  */
 #define GLFW_MOD_NUM_LOCK        0x0080
+#define GLFW_MOD_LAST            GLFW_MOD_NUM_LOCK
 #define GLFW_LOCK_MASK           (GLFW_MOD_NUM_LOCK | GLFW_MOD_CAPS_LOCK)
 
 /*! @} */
@@ -1024,6 +1025,16 @@ typedef enum GLFWMouseButton {
  *  [window hint](@ref GLFW_COCOA_GRAPHICS_SWITCHING_hint).
  */
 #define GLFW_COCOA_GRAPHICS_SWITCHING 0x00023003
+/*! @brief macOS specific
+ *  [window hint](@ref GLFW_COCOA_COLOR_SPACE_hint).
+ */
+#define GLFW_COCOA_COLOR_SPACE 0x00023004
+typedef enum {
+    DEFAULT_COLORSPACE = 0,
+    SRGB_COLORSPACE = 1,
+    DISPLAY_P3_COLORSPACE = 2,
+} GlfwCocoaColorSpaces;
+
 /*! @brief X11 specific
  *  [window hint](@ref GLFW_X11_CLASS_NAME_hint).
  */
@@ -1206,7 +1217,8 @@ typedef enum {
 typedef enum {
     GLFW_IME_NONE,
     GLFW_IME_PREEDIT_CHANGED,
-    GLFW_IME_COMMIT_TEXT
+    GLFW_IME_COMMIT_TEXT,
+    GLFW_IME_WAYLAND_DONE_EVENT,
 } GLFWIMEState;
 
 typedef enum {
@@ -1705,6 +1717,7 @@ typedef void (* GLFWjoystickfun)(int,int);
 typedef void (* GLFWuserdatafun)(unsigned long long, void*);
 typedef void (* GLFWtickcallback)(void*);
 typedef bool (* GLFWdrawtextfun)(GLFWwindow *window, const char *text, uint32_t fg, uint32_t bg, uint8_t *output_buf, size_t width, size_t height, float x_offset, float y_offset, size_t right_margin);
+typedef char* (* GLFWcurrentselectionfun)(void);
 
 /*! @brief Video mode type.
  *
@@ -1862,6 +1875,7 @@ GLFWAPI unsigned long long glfwAddTimer(monotonic_t interval, bool repeats, GLFW
 GLFWAPI void glfwUpdateTimer(unsigned long long timer_id, monotonic_t interval, bool enabled);
 GLFWAPI void glfwRemoveTimer(unsigned long long);
 GLFWAPI GLFWdrawtextfun glfwSetDrawTextFunction(GLFWdrawtextfun function);
+GLFWAPI GLFWcurrentselectionfun glfwSetCurrentSelectionCallback(GLFWcurrentselectionfun callback);
 
 /*! @brief Terminates the GLFW library.
  *
@@ -2757,6 +2771,7 @@ GLFWAPI void glfwWindowHintString(int hint, const char* value);
 GLFWAPI GLFWwindow* glfwCreateWindow(int width, int height, const char* title, GLFWmonitor* monitor, GLFWwindow* share);
 GLFWAPI bool glfwToggleFullscreen(GLFWwindow *window, unsigned int flags);
 GLFWAPI bool glfwIsFullscreen(GLFWwindow *window, unsigned int flags);
+GLFWAPI bool glfwAreSwapsAllowed(const GLFWwindow* window);
 
 /*! @brief Destroys the specified window and its context.
  *

glfw/init.c

@@ -386,3 +386,10 @@ GLFWAPI GLFWdrawtextfun glfwSetDrawTextFunction(GLFWdrawtextfun cbfun)
     _GLFW_SWAP_POINTERS(_glfw.callbacks.draw_text, cbfun);
     return cbfun;
 }
+
+GLFWAPI GLFWcurrentselectionfun glfwSetCurrentSelectionCallback(GLFWcurrentselectionfun cbfun)
+{
+    _GLFW_REQUIRE_INIT_OR_RETURN(NULL);
+    _GLFW_SWAP_POINTERS(_glfw.callbacks.get_current_selection, cbfun);
+    return cbfun;
+}

glfw/input.c

@@ -1540,7 +1540,7 @@ GLFWAPI const char* glfwGetClipboardString(GLFWwindow* handle UNUSED)
     return _glfwPlatformGetClipboardString();
 }
 
-#if defined(_GLFW_X11) || defined(_GLFW_WAYLAND)
+#if defined(_GLFW_X11) || defined(_GLFW_WAYLAND) || defined(__APPLE__)
 GLFWAPI void glfwSetPrimarySelectionString(GLFWwindow* handle UNUSED, const char* string)
 {
     assert(string != NULL);

glfw/internal.h

@@ -52,6 +52,8 @@
 #define GLFW_INCLUDE_NONE
 #include "glfw3.h"
 
+#define EGL_PRESENT_OPAQUE_EXT 0x31df
+
 #define _GLFW_INSERT_FIRST      0
 #define _GLFW_INSERT_LAST       1
 
@@ -307,6 +309,7 @@ struct _GLFWwndconfig
     bool          scaleToMonitor;
     struct {
         bool      retina;
+        int       color_space;
         char      frameName[256];
     } ns;
     struct {
@@ -438,6 +441,11 @@ struct _GLFWwindow
     bool                rawMouseMotion;
 
     _GLFWcontext        context;
+#ifdef _GLFW_WAYLAND
+    bool                swaps_disallowed;
+#else
+    const bool                swaps_disallowed;
+#endif
 
     struct {
         GLFWwindowposfun        pos;
@@ -613,6 +621,7 @@ struct _GLFWlibrary
         GLFWjoystickfun joystick;
         GLFWapplicationclosefun application_close;
         GLFWdrawtextfun draw_text;
+        GLFWcurrentselectionfun get_current_selection;
     } callbacks;
 
 
@@ -667,7 +676,7 @@ void _glfwPlatformSetGammaRamp(_GLFWmonitor* monitor, const GLFWgammaramp* ramp)
 
 void _glfwPlatformSetClipboardString(const char* string);
 const char* _glfwPlatformGetClipboardString(void);
-#if defined(_GLFW_X11) || defined(_GLFW_WAYLAND)
+#if defined(_GLFW_X11) || defined(_GLFW_WAYLAND) || defined(__APPLE__)
 void _glfwPlatformSetPrimarySelectionString(const char* string);
 const char* _glfwPlatformGetPrimarySelectionString(void);
 #endif

glfw/linux_desktop_settings.c

@@ -10,77 +10,118 @@
 #include <strings.h>
 #include <string.h>
 
-static const char *DESKTOP_SERVICE = "org.freedesktop.portal.Desktop";
+#define DESKTOP_SERVICE "org.freedesktop.portal.Desktop"
-static const char *DESKTOP_PATH = "/org/freedesktop/portal/desktop";
+#define DESKTOP_PATH "/org/freedesktop/portal/desktop"
-static const char *DESKTOP_INTERFACE = "org.freedesktop.portal.Settings";
+#define DESKTOP_INTERFACE "org.freedesktop.portal.Settings"
-static const char *GNOME_DESKTOP_NAMESPACE = "org.gnome.desktop.interface";
+#define GNOME_DESKTOP_NAMESPACE "org.gnome.desktop.interface"
+#define FDO_DESKTOP_NAMESPACE "org.freedesktop.appearance"
+#define FDO_APPEARANCE_KEY "color-scheme"
 
 
-static char theme_name[64] = {0};
+static char theme_name[128] = {0};
 static int theme_size = -1;
-static bool gnome_cursor_theme_read = false, gnome_cursor_size_read = false;
+static uint32_t appearance = 0;
+static bool is_gnome = false;
+static bool cursor_theme_changed = false;
 
-static bool
+#define HANDLER(name) static void name(DBusMessage *msg, const char* errmsg, void *data) { \
-parse_dbus_message_for_type(DBusMessage *const reply, const char *errmsg, const int type, void *value) {
-	DBusMessageIter iter[3];
-	dbus_message_iter_init(reply, &iter[0]);
-#define FAIL { _glfwInputError(GLFW_PLATFORM_ERROR, "%s", errmsg); return false; }
-	if (dbus_message_iter_get_arg_type(&iter[0]) != DBUS_TYPE_VARIANT) FAIL;
-	dbus_message_iter_recurse(&iter[0], &iter[1]);
-	if (dbus_message_iter_get_arg_type(&iter[1]) != DBUS_TYPE_VARIANT) FAIL;
-	dbus_message_iter_recurse(&iter[1], &iter[2]);
-	if (dbus_message_iter_get_arg_type(&iter[2]) != type) FAIL;
-	dbus_message_iter_get_basic(&iter[2], value);
-	return true;
-#undef FAIL
-}
-
-#define HANDLER(name) void name(DBusMessage *msg, const char* errmsg, void *data) { \
     (void)data; \
     if (errmsg) { \
         _glfwInputError(GLFW_PLATFORM_ERROR, "%s: failed with error: %s", #name, errmsg); \
         return; \
     }
 
-HANDLER(on_gnome_cursor_theme_read)
+static void
-    const char *name;
+process_fdo_setting(const char *key, DBusMessageIter *value) {
-    if (!parse_dbus_message_for_type(msg, "Failed to get cursor theme name from reply", DBUS_TYPE_STRING, &name)) return;
+    if (strcmp(key, FDO_APPEARANCE_KEY) == 0) {
-    if (name && name[0]) {
+        if (dbus_message_iter_get_arg_type(value) == DBUS_TYPE_UINT32) {
-        gnome_cursor_theme_read = true;
+            dbus_message_iter_get_basic(value, &appearance);
-        strncpy(theme_name, name, sizeof(theme_name) - 1);
+            if (appearance > 2) appearance = 0;
-        if (gnome_cursor_size_read) _glfwPlatformChangeCursorTheme();
+        }
     }
 }
 
-HANDLER(on_gnome_cursor_size_read)
-    int32_t sz;
-    if (!parse_dbus_message_for_type(msg, "Failed to get cursor theme size from reply", DBUS_TYPE_INT32, &sz)) return;
-    gnome_cursor_size_read = true;
-    theme_size = sz;
-    if (gnome_cursor_theme_read) _glfwPlatformChangeCursorTheme();
-}
-#undef HANDLER
-
-
-static bool
-call_read(DBusConnection *session_bus, dbus_pending_callback callback, const char *namespace, const char *key) {
-    return glfw_dbus_call_method_with_reply(
-            session_bus, DESKTOP_SERVICE, DESKTOP_PATH, DESKTOP_INTERFACE, "Read", DBUS_TIMEOUT_USE_DEFAULT,
-            callback, NULL, DBUS_TYPE_STRING, &namespace, DBUS_TYPE_STRING, &key, DBUS_TYPE_INVALID);
-}
-
 static void
-get_from_gnome(void) {
+process_gnome_setting(const char *key, DBusMessageIter *value) {
-    theme_size = 32;
+    if (strcmp(key, "cursor-size") == 0) {
-    DBusConnection *session_bus = glfw_dbus_session_bus();
+        if (dbus_message_iter_get_arg_type(value) == DBUS_TYPE_INT32) {
-    if (session_bus) {
+            int32_t sz;
-        const char *theme_key = "cursor-theme";
+            dbus_message_iter_get_basic(value, &sz);
-        call_read(session_bus, on_gnome_cursor_theme_read, GNOME_DESKTOP_NAMESPACE, theme_key);
+            if (sz > 0 && sz != theme_size) {
-        const char *size_key = "cursor-size";
+                theme_size = sz;
-        call_read(session_bus, on_gnome_cursor_size_read, GNOME_DESKTOP_NAMESPACE, size_key);
+                cursor_theme_changed = true;
+            }
+        }
+    } else if (strcmp(key, "cursor-theme") == 0) {
+        if (dbus_message_iter_get_arg_type(value) == DBUS_TYPE_STRING) {
+            const char *name;
+            dbus_message_iter_get_basic(value, &name);
+            if (name) {
+                strncpy(theme_name, name, sizeof(theme_name) - 1);
+                cursor_theme_changed = true;
+            }
+        }
     }
 }
 
+static void
+process_settings_dict(DBusMessageIter *array_iter, void(process_setting)(const char *, DBusMessageIter*)) {
+    DBusMessageIter item_iter, value_iter;
+    while (dbus_message_iter_get_arg_type(array_iter) == DBUS_TYPE_DICT_ENTRY) {
+        dbus_message_iter_recurse(array_iter, &item_iter);
+        if (dbus_message_iter_get_arg_type(&item_iter) == DBUS_TYPE_STRING) {
+            const char *key;
+            dbus_message_iter_get_basic(&item_iter, &key);
+            if (dbus_message_iter_next(&item_iter) && dbus_message_iter_get_arg_type(&item_iter) == DBUS_TYPE_VARIANT) {
+                dbus_message_iter_recurse(&item_iter, &value_iter);
+                process_setting(key, &value_iter);
+            }
+        }
+        if (!dbus_message_iter_next(array_iter)) break;
+    }
+}
+
+HANDLER(process_desktop_settings)
+    cursor_theme_changed = false;
+    DBusMessageIter root, array, item, settings;
+    dbus_message_iter_init(msg, &root);
+#define die(...) { _glfwInputError(GLFW_PLATFORM_ERROR, __VA_ARGS__); return; }
+    if (dbus_message_iter_get_arg_type(&root) != DBUS_TYPE_ARRAY) die("Reply to request for desktop settings is not an array");
+    dbus_message_iter_recurse(&root, &array);
+    while (dbus_message_iter_get_arg_type(&array) == DBUS_TYPE_DICT_ENTRY) {
+        dbus_message_iter_recurse(&array, &item);
+        if (dbus_message_iter_get_arg_type(&item) == DBUS_TYPE_STRING) {
+            const char *namespace;
+            dbus_message_iter_get_basic(&item, &namespace);
+            if (dbus_message_iter_next(&item) && dbus_message_iter_get_arg_type(&item) == DBUS_TYPE_ARRAY) {
+                dbus_message_iter_recurse(&item, &settings);
+                if (strcmp(namespace, FDO_DESKTOP_NAMESPACE) == 0) {
+                    process_settings_dict(&settings, process_fdo_setting);
+                } else if (is_gnome && strcmp(namespace, GNOME_DESKTOP_NAMESPACE) == 0) {
+                    process_settings_dict(&settings, process_gnome_setting);
+                }
+            }
+        }
+        if (!dbus_message_iter_next(&array)) break;
+    }
+#undef die
+    if (cursor_theme_changed) _glfwPlatformChangeCursorTheme();
+}
+
+#undef HANDLER
+
+static bool
+read_desktop_settings(DBusConnection *session_bus) {
+    DBusMessage *msg = dbus_message_new_method_call(DESKTOP_SERVICE, DESKTOP_PATH, DESKTOP_INTERFACE, "ReadAll");
+    if (!msg) return false;
+    DBusMessageIter iter, array_iter;
+    dbus_message_iter_init_append(msg, &iter);
+    if (!dbus_message_iter_open_container(&iter, DBUS_TYPE_ARRAY, "s", &array_iter)) { dbus_message_unref(msg); return false; }
+    if (!dbus_message_iter_close_container(&iter, &array_iter)) { dbus_message_unref(msg); return false; }
+    bool ok = call_method_with_msg(session_bus, msg, DBUS_TIMEOUT_USE_DEFAULT, process_desktop_settings, NULL);
+    dbus_message_unref(msg);
+    return ok;
+}
 
 void
 glfw_current_cursor_theme(const char **theme, int *size) {
@@ -100,10 +141,55 @@ get_cursor_theme_from_env(void) {
     }
 }
 
+static void
+on_color_scheme_change(DBusMessage *message) {
+    DBusMessageIter iter[2];
+    dbus_message_iter_init (message, &iter[0]);
+    int current_type;
+    while ((current_type = dbus_message_iter_get_arg_type (&iter[0])) != DBUS_TYPE_INVALID) {
+        if (current_type == DBUS_TYPE_VARIANT) {
+            dbus_message_iter_recurse(&iter[0], &iter[1]);
+            if (dbus_message_iter_get_arg_type(&iter[1]) == DBUS_TYPE_UINT32) {
+                uint32_t val = 0;
+                dbus_message_iter_get_basic(&iter[1], &val);
+                if (val > 2) val = 0;
+                if (val != appearance) {
+                    appearance = val;
+                }
+            }
+            break;
+        }
+        dbus_message_iter_next(&iter[0]);
+    }
+}
+
+static DBusHandlerResult
+setting_changed(DBusConnection *conn UNUSED, DBusMessage *msg, void *user_data UNUSED) {
+    /* printf("session_bus settings_changed invoked interface: %s member: %s\n", dbus_message_get_interface(msg), dbus_message_get_member(msg)); */
+    if (dbus_message_is_signal(msg, DESKTOP_INTERFACE, "SettingChanged")) {
+        const char *namespace = NULL, *key = NULL;
+        if (glfw_dbus_get_args(msg, "Failed to get namespace and key from SettingChanged notification signal", DBUS_TYPE_STRING, &namespace, DBUS_TYPE_STRING, &key, DBUS_TYPE_INVALID)) {
+            if (strcmp(namespace, FDO_DESKTOP_NAMESPACE) == 0) {
+                if (strcmp(key, FDO_APPEARANCE_KEY) == 0) {
+                    on_color_scheme_change(msg);
+                }
+            }
+        }
+
+    }
+    return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
+}
+
+
 void
 glfw_initialize_desktop_settings(void) {
     get_cursor_theme_from_env();
     const char *desktop = getenv("XDG_CURRENT_DESKTOP");
-    bool is_gnome = desktop && strncasecmp(desktop, "GNOME", sizeof("GNOME") - 1) == 0;
+    is_gnome = desktop && strstr(desktop, "GNOME");
-    if (is_gnome) get_from_gnome();
+    DBusConnection *session_bus = glfw_dbus_session_bus();
+    if (session_bus) {
+        if (!read_desktop_settings(session_bus)) _glfwInputError(GLFW_PLATFORM_ERROR, "Failed to read desktop settings, make sure you have the desktop portal running.");
+        dbus_bus_add_match(session_bus, "type='signal',interface='" DESKTOP_INTERFACE "',member='SettingChanged'", NULL);
+        dbus_connection_add_filter(session_bus, setting_changed, NULL, NULL);
+    }
 }

glfw/window.c

@@ -332,6 +332,8 @@ void glfwDefaultWindowHints(void)
 
     // The default is to use full Retina resolution framebuffers
     _glfw.hints.window.ns.retina = true;
+    // use the default colorspace assigned by the system
+    _glfw.hints.window.ns.color_space = 0;
 }
 
 GLFWAPI void glfwWindowHint(int hint, int value)
@@ -412,6 +414,9 @@ GLFWAPI void glfwWindowHint(int hint, int value)
         case GLFW_COCOA_RETINA_FRAMEBUFFER:
             _glfw.hints.window.ns.retina = value ? true : false;
             return;
+        case GLFW_COCOA_COLOR_SPACE:
+            _glfw.hints.window.ns.color_space = value;
+            return;
         case GLFW_COCOA_GRAPHICS_SWITCHING:
             _glfw.hints.context.nsgl.offline = value ? true : false;
             return;
@@ -1062,6 +1067,10 @@ GLFWAPI bool glfwIsFullscreen(GLFWwindow* wh, unsigned int flags) {
     return _glfwPlatformIsFullscreen((_GLFWwindow*)wh, flags);
 }
 
+GLFWAPI bool glfwAreSwapsAllowed(const GLFWwindow* wh) {
+    return !(((_GLFWwindow*)wh)->swaps_disallowed);
+}
+
 GLFWAPI void glfwSetWindowUserPointer(GLFWwindow* handle, void* pointer)
 {
     _GLFWwindow* window = (_GLFWwindow*) handle;

glfw/wl_client_side_decorations.c

@@ -31,13 +31,13 @@ static void
 build_blur_kernel(kernel_type *blur_kernel, const size_t size, kernel_type sigma) {
     // 1D Normalized Gaussian
     const kernel_type half = size / (kernel_type)2;
-	kernel_type sum = 0;
+    kernel_type sum = 0;
-	for (size_t i = 0; i < size; i++) {
+    for (size_t i = 0; i < size; i++) {
-		kernel_type f = (i - half);
+        kernel_type f = (i - half);
-		blur_kernel[i] = (kernel_type)exp(- f * f / sigma);
+        blur_kernel[i] = (kernel_type)exp(- f * f / sigma);
-		sum += blur_kernel[i];
+        sum += blur_kernel[i];
-	}
+    }
-	for (size_t i = 0; i < size; i++) blur_kernel[i] /= sum;
+    for (size_t i = 0; i < size; i++) blur_kernel[i] /= sum;
 }
 
 static void
@@ -102,13 +102,31 @@ init_buffer_pair(_GLFWWaylandBufferPair *pair, size_t width, size_t height, unsi
     return 2 * pair->size_in_bytes;
 }
 
+static bool
+window_has_buffer(_GLFWwindow *window, struct wl_buffer *q) {
+#define Q(which) decs.which.buffer.a == q || decs.which.buffer.b == q
+    return Q(left) || Q(top) || Q(right) || Q(bottom);
+#undef Q
+}
+
 static void
-alloc_buffer_pair(_GLFWWaylandBufferPair *pair, struct wl_shm_pool *pool, uint8_t *data, size_t *offset) {
+buffer_release_event(void *data, struct wl_buffer *buffer) {
+    wl_buffer_destroy(buffer);
+    _GLFWwindow *window = _glfwWindowForId((uintptr_t)data);
+    if (window && window_has_buffer(window, buffer)) decs.buffer_destroyed = true;
+}
+
+static struct wl_buffer_listener handle_buffer_events = {.release = buffer_release_event};
+
+static void
+alloc_buffer_pair(uintptr_t window_id, _GLFWWaylandBufferPair *pair, struct wl_shm_pool *pool, uint8_t *data, size_t *offset) {
     pair->data.a = data + *offset;
     pair->a = wl_shm_pool_create_buffer(pool, *offset, pair->width, pair->height, pair->stride, WL_SHM_FORMAT_ARGB8888);
+    wl_buffer_add_listener(pair->a, &handle_buffer_events, (void*)window_id);
     *offset += pair->size_in_bytes;
     pair->data.b = data + *offset;
     pair->b = wl_shm_pool_create_buffer(pool, *offset, pair->width, pair->height, pair->stride, WL_SHM_FORMAT_ARGB8888);
+    wl_buffer_add_listener(pair->b, &handle_buffer_events, (void*)window_id);
     *offset += pair->size_in_bytes;
     pair->front = pair->a; pair->back = pair->b;
     pair->data.front = pair->data.a; pair->data.back = pair->data.b;
@@ -263,11 +281,11 @@ static bool
 create_shm_buffers(_GLFWwindow* window) {
     const unsigned scale = window->wl.scale >= 1 ? window->wl.scale : 1;
 
-    const size_t vertical_width = decs.metrics.width, vertical_height = window->wl.current.height + decs.metrics.top;
+    const size_t vertical_width = decs.metrics.width, vertical_height = window->wl.height + decs.metrics.top;
-    const size_t horizontal_height = decs.metrics.width, horizontal_width = window->wl.current.width + 2 * decs.metrics.width;
+    const size_t horizontal_height = decs.metrics.width, horizontal_width = window->wl.width + 2 * decs.metrics.width;
 
     decs.mapping.size = 0;
-    decs.mapping.size += init_buffer_pair(&decs.top.buffer, window->wl.current.width, decs.metrics.top, scale);
+    decs.mapping.size += init_buffer_pair(&decs.top.buffer, window->wl.width, decs.metrics.top, scale);
     decs.mapping.size += init_buffer_pair(&decs.left.buffer, vertical_width, vertical_height, scale);
     decs.mapping.size += init_buffer_pair(&decs.bottom.buffer, horizontal_width, horizontal_height, scale);
     decs.mapping.size += init_buffer_pair(&decs.right.buffer, vertical_width, vertical_height, scale);
@@ -287,7 +305,7 @@ create_shm_buffers(_GLFWwindow* window) {
     struct wl_shm_pool* pool = wl_shm_create_pool(_glfw.wl.shm, fd, decs.mapping.size);
     close(fd);
     size_t offset = 0;
-#define a(which) alloc_buffer_pair(&decs.which.buffer, pool, decs.mapping.data, &offset)
+#define a(which) alloc_buffer_pair(window->id, &decs.which.buffer, pool, decs.mapping.data, &offset)
     a(top); a(left); a(bottom); a(right);
 #undef a
     wl_shm_pool_destroy(pool);
@@ -313,8 +331,6 @@ free_csd_surfaces(_GLFWwindow *window) {
 static void
 free_csd_buffers(_GLFWwindow *window) {
 #define d(which) { \
-    if (decs.which.buffer.a) wl_buffer_destroy(decs.which.buffer.a); \
-    if (decs.which.buffer.b) wl_buffer_destroy(decs.which.buffer.b); \
     memset(&decs.which.buffer, 0, sizeof(_GLFWWaylandBufferPair)); \
 }
     d(left); d(top); d(right); d(bottom);
@@ -347,16 +363,19 @@ ensure_csd_resources(_GLFWwindow *window) {
     const bool is_focused = window->id == _glfw.focusedWindowId;
     const bool focus_changed = is_focused != decs.for_window_state.focused;
     const bool size_changed = (
-        decs.for_window_state.width != window->wl.current.width ||
+        decs.for_window_state.width != window->wl.width ||
-        decs.for_window_state.height != window->wl.current.height ||
+        decs.for_window_state.height != window->wl.height ||
         decs.for_window_state.scale != window->wl.scale ||
         !decs.mapping.data
     );
-    const bool needs_update = focus_changed || size_changed || !decs.left.surface;
+    const bool needs_update = focus_changed || size_changed || !decs.left.surface || decs.buffer_destroyed;
+    debug("CSD: old.size: %dx%d new.size: %dx%d needs_update: %d size_changed: %d buffer_destroyed: %d\n",
+            decs.for_window_state.width, decs.for_window_state.height, window->wl.width, window->wl.height, needs_update, size_changed, decs.buffer_destroyed);
     if (!needs_update) return false;
-    if (size_changed) {
+    if (size_changed || decs.buffer_destroyed) {
         free_csd_buffers(window);
         if (!create_shm_buffers(window)) return false;
+        decs.buffer_destroyed = false;
     }
 
     int32_t x, y, scale = window->wl.scale < 1 ? 1 : window->wl.scale;
@@ -368,11 +387,11 @@ ensure_csd_resources(_GLFWwindow *window) {
     if (!decs.left.surface) create_csd_surfaces(window, &decs.left);
     position_csd_surface(&decs.left, x, y, scale);
 
-    x = -decs.metrics.width; y = window->wl.current.height;
+    x = -decs.metrics.width; y = window->wl.height;
     if (!decs.bottom.surface) create_csd_surfaces(window, &decs.bottom);
     position_csd_surface(&decs.bottom, x, y, scale);
 
-    x = window->wl.current.width; y = -decs.metrics.top;
+    x = window->wl.width; y = -decs.metrics.top;
     if (!decs.right.surface) create_csd_surfaces(window, &decs.right);
     position_csd_surface(&decs.right, x, y, scale);
 
@@ -382,8 +401,8 @@ ensure_csd_resources(_GLFWwindow *window) {
     damage_csd(bottom, is_focused ? decs.bottom.buffer.front : decs.bottom.buffer.back);
     damage_csd(right, is_focused ? decs.right.buffer.front : decs.right.buffer.back);
 
-    decs.for_window_state.width = window->wl.current.width;
+    decs.for_window_state.width = window->wl.width;
-    decs.for_window_state.height = window->wl.current.height;
+    decs.for_window_state.height = window->wl.height;
     decs.for_window_state.scale = window->wl.scale;
     decs.for_window_state.focused = is_focused;
     return true;

glfw/wl_init.c

@@ -54,6 +54,8 @@
 #endif
 
 
+#define debug(...) if (_glfw.hints.init.debugRendering) fprintf(stderr, __VA_ARGS__);
+
 static int min(int n1, int n2)
 {
     return n1 < n2 ? n1 : n2;
@@ -96,7 +98,6 @@ static void pointerHandleEnter(void* data UNUSED,
         if (!window)
             return;
     }
-
     window->wl.decorations.focus = focus;
     _glfw.wl.serial = serial;
     _glfw.wl.pointerFocus = window;
@@ -142,10 +143,15 @@ static void setCursor(GLFWCursorShape shape, _GLFWwindow* window)
 
     if (!image)
         return;
+    if (image->width % scale || image->height % scale) {
+        _glfwInputError(GLFW_PLATFORM_ERROR, "WARNING: Cursor image size: %dx%d is not a multiple of window scale: %d. This will"
+                " cause some compositors such as GNOME to crash. See https://github.com/kovidgoyal/kitty/issues/4878", image->width, image->height, scale);
+    }
 
     buffer = wl_cursor_image_get_buffer(image);
     if (!buffer)
         return;
+    debug("Calling wl_pointer_set_cursor in setCursor with surface: %p\n", (void*)surface);
     wl_pointer_set_cursor(_glfw.wl.pointer, _glfw.wl.serial,
                           surface,
                           image->hotspot_x / scale,
@@ -206,7 +212,7 @@ static void pointerHandleMotion(void* data UNUSED,
         case BOTTOM_DECORATION:
             if (x < window->wl.decorations.metrics.width)
                 cursorShape = GLFW_SW_RESIZE_CURSOR;
-            else if (x > window->wl.current.width + window->wl.decorations.metrics.width)
+            else if (x > window->wl.width + window->wl.decorations.metrics.width)
                 cursorShape = GLFW_SE_RESIZE_CURSOR;
             else
                 cursorShape = GLFW_VRESIZE_CURSOR;
@@ -274,7 +280,7 @@ static void pointerHandleButton(void* data UNUSED,
             case BOTTOM_DECORATION:
                 if (x < window->wl.decorations.metrics.width)
                     edges = XDG_TOPLEVEL_RESIZE_EDGE_BOTTOM_LEFT;
-                else if (x > window->wl.current.width + window->wl.decorations.metrics.width)
+                else if (x > window->wl.width + window->wl.decorations.metrics.width)
                     edges = XDG_TOPLEVEL_RESIZE_EDGE_BOTTOM_RIGHT;
                 else
                     edges = XDG_TOPLEVEL_RESIZE_EDGE_BOTTOM;
@@ -567,6 +573,7 @@ static void seatHandleCapabilities(void* data UNUSED,
     {
         wl_pointer_destroy(_glfw.wl.pointer);
         _glfw.wl.pointer = NULL;
+        if (_glfw.wl.cursorAnimationTimer) toggleTimer(&_glfw.wl.eventLoopData, _glfw.wl.cursorAnimationTimer, 0);
     }
 
     if ((caps & WL_SEAT_CAPABILITY_KEYBOARD) && !_glfw.wl.keyboard)
@@ -578,6 +585,8 @@ static void seatHandleCapabilities(void* data UNUSED,
     {
         wl_keyboard_destroy(_glfw.wl.keyboard);
         _glfw.wl.keyboard = NULL;
+        _glfw.wl.keyboardFocusId = 0;
+        if (_glfw.wl.keyRepeatInfo.keyRepeatTimer) toggleTimer(&_glfw.wl.eventLoopData, _glfw.wl.keyRepeatInfo.keyRepeatTimer, 0);
     }
 }
 

glfw/wl_platform.h

@@ -116,22 +116,27 @@ typedef enum WaylandWindowState {
     TOPLEVEL_STATE_NONE = 0,
     TOPLEVEL_STATE_MAXIMIZED = 1,
     TOPLEVEL_STATE_FULLSCREEN = 2,
-	TOPLEVEL_STATE_RESIZING = 4,
+    TOPLEVEL_STATE_RESIZING = 4,
-	TOPLEVEL_STATE_ACTIVATED = 8,
+    TOPLEVEL_STATE_ACTIVATED = 8,
-	TOPLEVEL_STATE_TILED_LEFT = 16,
+    TOPLEVEL_STATE_TILED_LEFT = 16,
-	TOPLEVEL_STATE_TILED_RIGHT = 32,
+    TOPLEVEL_STATE_TILED_RIGHT = 32,
-	TOPLEVEL_STATE_TILED_TOP = 64,
+    TOPLEVEL_STATE_TILED_TOP = 64,
-	TOPLEVEL_STATE_TILED_BOTTOM = 128,
+    TOPLEVEL_STATE_TILED_BOTTOM = 128,
 } WaylandWindowState;
 
 
 static const WaylandWindowState TOPLEVEL_STATE_DOCKED = TOPLEVEL_STATE_MAXIMIZED | TOPLEVEL_STATE_FULLSCREEN | TOPLEVEL_STATE_TILED_TOP | TOPLEVEL_STATE_TILED_LEFT | TOPLEVEL_STATE_TILED_RIGHT | TOPLEVEL_STATE_TILED_BOTTOM;
 
+enum WaylandWindowPendingState {
+    PENDING_STATE_TOPLEVEL = 1,
+    PENDING_STATE_DECORATION = 2
+};
 
 // Wayland-specific per-window data
 //
 typedef struct _GLFWwindowWayland
 {
+    int                         width, height;
     bool                        visible;
     bool                        hovered;
     bool                        transparent;
@@ -167,7 +172,7 @@ typedef struct _GLFWwindowWayland
     struct zwp_idle_inhibitor_v1*          idleInhibitor;
 
     struct {
-        bool serverSide;
+        bool serverSide, buffer_destroyed;
         _GLFWdecorationSideWayland focus;
         _GLFWWaylandCSDEdge top, left, right, bottom;
 
@@ -215,11 +220,13 @@ typedef struct _GLFWwindowWayland
     struct {
         unsigned int x, y;
     } axis_discrete_count;
+    bool surface_configured_once;
 
+    uint32_t pending_state;
     struct {
         int width, height;
         uint32_t toplevel_states;
-        bool set;
+        uint32_t decoration_mode;
     } current, pending;
 } _GLFWwindowWayland;
 

glfw/wl_text_input.c

@@ -47,7 +47,7 @@ static void
 send_text(const char *text, GLFWIMEState ime_state) {
     _GLFWwindow *w = _glfwFocusedWindow();
     if (w && w->callbacks.keyboard) {
-        GLFWkeyevent fake_ev = {.action = GLFW_PRESS};
+        GLFWkeyevent fake_ev = {.action = text ? GLFW_PRESS : GLFW_RELEASE};
         fake_ev.text = text;
         fake_ev.ime_state = ime_state;
         w->callbacks.keyboard((GLFWwindow*) w, &fake_ev);
@@ -84,15 +84,18 @@ text_input_delete_surrounding_text(
 }
 
 static void
-text_input_done(void *data UNUSED, struct zwp_text_input_v3 *txt_input UNUSED, uint32_t serial UNUSED) {
+text_input_done(void *data UNUSED, struct zwp_text_input_v3 *txt_input UNUSED, uint32_t serial) {
     debug("text-input: done event: serial: %u current_commit_serial: %u\n", serial, commit_serial);
     if (serial != commit_serial) {
-        _glfwInputError(GLFW_PLATFORM_ERROR, "Wayland: text_input_done serial mismatch, expected=%u got=%u\n", commit_serial, serial);
+        if (serial > commit_serial) _glfwInputError(GLFW_PLATFORM_ERROR, "Wayland: text_input_done serial mismatch, expected=%u got=%u\n", commit_serial, serial);
         return;
     }
     if (pending_pre_edit) {
         send_text(pending_pre_edit, GLFW_IME_PREEDIT_CHANGED);
         free(pending_pre_edit); pending_pre_edit = NULL;
+    } else {
+        // Clear pre-edit text
+        send_text(NULL, GLFW_IME_WAYLAND_DONE_EVENT);
     }
     if (pending_commit) {
         send_text(pending_commit, GLFW_IME_COMMIT_TEXT);
@@ -139,7 +142,20 @@ _glfwPlatformUpdateIMEState(_GLFWwindow *w, const GLFWIMEUpdateEvent *ev) {
     switch(ev->type) {
         case GLFW_IME_UPDATE_FOCUS:
             debug("\ntext-input: updating IME focus state, focused: %d\n", ev->focused);
-            if (ev->focused) zwp_text_input_v3_enable(text_input); else zwp_text_input_v3_disable(text_input);
+            if (ev->focused) {
+                zwp_text_input_v3_enable(text_input);
+                zwp_text_input_v3_set_content_type(text_input, ZWP_TEXT_INPUT_V3_CONTENT_HINT_NONE, ZWP_TEXT_INPUT_V3_CONTENT_PURPOSE_TERMINAL);
+            } else {
+                if (pending_pre_edit) {
+                    // Clear pre-edit text
+                    send_text(NULL, GLFW_IME_PREEDIT_CHANGED);
+                    free(pending_pre_edit); pending_pre_edit = NULL;
+                }
+                if (pending_commit) {
+                    free(pending_commit); pending_commit = NULL;
+                }
+                zwp_text_input_v3_disable(text_input);
+            }
             commit();
             break;
         case GLFW_IME_UPDATE_CURSOR_POSITION: {

glfw/wl_window.c

@@ -147,6 +147,7 @@ setCursorImage(_GLFWwindow* window, bool on_theme_change) {
         cursorWayland->yhot = image->hotspot_y;
     }
 
+    debug("Calling wl_pointer_set_cursor in setCursorImage with surface: %p\n", (void*)surface);
     wl_pointer_set_cursor(_glfw.wl.pointer, _glfw.wl.serial,
                           surface,
                           cursorWayland->xhot / scale,
@@ -206,7 +207,7 @@ static void setOpaqueRegion(_GLFWwindow* window)
     if (!region)
         return;
 
-    wl_region_add(region, 0, 0, window->wl.current.width, window->wl.current.height);
+    wl_region_add(region, 0, 0, window->wl.width, window->wl.height);
     wl_surface_set_opaque_region(window->wl.surface, region);
     wl_surface_commit(window->wl.surface);
     wl_region_destroy(region);
@@ -216,9 +217,9 @@ static void setOpaqueRegion(_GLFWwindow* window)
 static void
 resizeFramebuffer(_GLFWwindow* window) {
     int scale = window->wl.scale;
-    int scaledWidth = window->wl.current.width * scale;
+    int scaledWidth = window->wl.width * scale;
-    int scaledHeight = window->wl.current.height * scale;
+    int scaledHeight = window->wl.height * scale;
-    debug("Resizing framebuffer to: %dx%d at scale: %d\n", window->wl.current.width, window->wl.current.height, scale);
+    debug("Resizing framebuffer to: %dx%d at scale: %d\n", window->wl.width, window->wl.height, scale);
     wl_egl_window_resize(window->wl.native, scaledWidth, scaledHeight, 0, 0);
     if (!window->wl.transparent) setOpaqueRegion(window);
     _glfwInputFramebufferSize(window, scaledWidth, scaledHeight);
@@ -234,24 +235,26 @@ clipboard_mime(void) {
     return buf;
 }
 
-static void
+static bool
 dispatchChangesAfterConfigure(_GLFWwindow *window, int32_t width, int32_t height) {
-    bool size_changed = width != window->wl.current.width || height != window->wl.current.height;
+    bool size_changed = width != window->wl.width || height != window->wl.height;
     bool scale_changed = checkScaleChange(window);
 
     if (size_changed) {
         _glfwInputWindowSize(window, width, height);
-        window->wl.current.width = width; window->wl.current.height = height;
+        window->wl.width = width; window->wl.height = height;
         resizeFramebuffer(window);
     }
 
     if (scale_changed) {
-        if (!size_changed)
+        debug("Scale changed to %d in dispatchChangesAfterConfigure\n", window->wl.scale);
-            resizeFramebuffer(window);
+        if (!size_changed) resizeFramebuffer(window);
         _glfwInputWindowContentScale(window, window->wl.scale, window->wl.scale);
     }
 
     _glfwInputWindowDamage(window);
+
+    return size_changed || scale_changed;
 }
 
 static void
@@ -269,24 +272,9 @@ xdgDecorationHandleConfigure(void* data,
                                          uint32_t mode)
 {
     _GLFWwindow* window = data;
-
+    window->wl.pending.decoration_mode = mode;
-    bool has_server_side_decorations = (mode == ZXDG_TOPLEVEL_DECORATION_V1_MODE_SERVER_SIDE);
+    window->wl.pending_state |= PENDING_STATE_DECORATION;
-    debug("XDG decoration configure event received: has_server_side_decorations: %d\n", has_server_side_decorations);
+    debug("XDG decoration configure event received: has_server_side_decorations: %d\n", (mode == ZXDG_TOPLEVEL_DECORATION_V1_MODE_SERVER_SIDE));
-    if (has_server_side_decorations == window->wl.decorations.serverSide) return;
-    window->wl.decorations.serverSide = has_server_side_decorations;
-    int width = window->wl.current.width, height = window->wl.current.height;
-    if (window->wl.decorations.serverSide) {
-        free_csd_surfaces(window);
-        height += window->wl.decorations.metrics.visible_titlebar_height;
-    } else {
-        ensure_csd_resources(window);
-    }
-    set_csd_window_geometry(window, &width, &height);
-    dispatchChangesAfterConfigure(window, width, height);
-    ensure_csd_resources(window);
-    wl_surface_commit(window->wl.surface);
-    debug("final window content size: %dx%d\n", window->wl.current.width, window->wl.current.height);
-    inform_compositor_of_window_geometry(window, "configure-decorations");
 }
 
 static const struct zxdg_toplevel_decoration_v1_listener xdgDecorationListener = {
@@ -311,6 +299,7 @@ static void surfaceHandleEnter(void *data,
     window->wl.monitors[window->wl.monitorsCount++] = monitor;
 
     if (checkScaleChange(window)) {
+        debug("Scale changed to %d in surface enter event\n", window->wl.scale);
         resizeFramebuffer(window);
         _glfwInputWindowContentScale(window, window->wl.scale, window->wl.scale);
         ensure_csd_resources(window);
@@ -336,6 +325,7 @@ static void surfaceHandleLeave(void *data,
     window->wl.monitors[--window->wl.monitorsCount] = NULL;
 
     if (checkScaleChange(window)) {
+        debug("Scale changed to %d in surface leave event\n", window->wl.scale);
         resizeFramebuffer(window);
         _glfwInputWindowContentScale(window, window->wl.scale, window->wl.scale);
         ensure_csd_resources(window);
@@ -384,8 +374,8 @@ static bool createSurface(_GLFWwindow* window,
     if (!window->wl.native)
         return false;
 
-    window->wl.current.width = wndconfig->width;
+    window->wl.width = wndconfig->width;
-    window->wl.current.height = wndconfig->height;
+    window->wl.height = wndconfig->height;
     window->wl.user_requested_content_size.width = wndconfig->width;
     window->wl.user_requested_content_size.height = wndconfig->height;
     window->wl.scale = 1;
@@ -479,7 +469,7 @@ xdgToplevelHandleConfigure(void* data,
     window->wl.pending.toplevel_states = new_states;
     window->wl.pending.width = width;
     window->wl.pending.height = height;
-    window->wl.pending.set = true;
+    window->wl.pending_state |= PENDING_STATE_TOPLEVEL;
 }
 
 static void xdgToplevelHandleClose(void* data,
@@ -500,11 +490,22 @@ static void xdgSurfaceHandleConfigure(void* data,
 {
     _GLFWwindow* window = data;
     xdg_surface_ack_configure(surface, serial);
-    if (window->wl.pending.set) {
+    if (window->wl.pending_state & PENDING_STATE_TOPLEVEL) {
         uint32_t new_states = window->wl.pending.toplevel_states;
         int width = window->wl.pending.width;
         int height = window->wl.pending.height;
-        window->wl.pending.set = false;
+        if (!window->wl.surface_configured_once) {
+            window->wl.surface_configured_once = true;
+            // this will attach the buffer to the surface, the client is responsible for clearing the buffer to an appropriate blank
+            window->swaps_disallowed = false;
+            window->context.swapBuffers(window);
+
+            if (!width && !height && !new_states && !window->wl.decorations.serverSide && getenv("XAUTHORITY") && strstr(getenv("XAUTHORITY"), "mutter")) {
+                // https://github.com/kovidgoyal/kitty/issues/4802
+                debug("Ignoring first empty surface configure event on mutter.\n");
+                return;
+            }
+        }
 
         if (new_states != window->wl.current.toplevel_states ||
                 width != window->wl.current.width ||
@@ -512,16 +513,39 @@ static void xdgSurfaceHandleConfigure(void* data,
 
             bool live_resize_done = !(new_states & TOPLEVEL_STATE_RESIZING) && (window->wl.current.toplevel_states & TOPLEVEL_STATE_RESIZING);
             window->wl.current.toplevel_states = new_states;
-            set_csd_window_geometry(window, &width, &height);
+            window->wl.current.width = width;
-            dispatchChangesAfterConfigure(window, width, height);
+            window->wl.current.height = height;
-            debug("final window content size: %dx%d\n", window->wl.current.width, window->wl.current.height);
             _glfwInputWindowFocus(window, window->wl.current.toplevel_states & TOPLEVEL_STATE_ACTIVATED);
-            ensure_csd_resources(window);
-            inform_compositor_of_window_geometry(window, "configure");
             if (live_resize_done) _glfwInputLiveResize(window, false);
         }
     }
-    wl_surface_commit(window->wl.surface);
+
+    if (window->wl.pending_state & PENDING_STATE_DECORATION) {
+        uint32_t mode = window->wl.pending.decoration_mode;
+        bool has_server_side_decorations = (mode == ZXDG_TOPLEVEL_DECORATION_V1_MODE_SERVER_SIDE);
+        window->wl.decorations.serverSide = has_server_side_decorations;
+        window->wl.current.decoration_mode = mode;
+    }
+
+    bool resized = false;
+    if (window->wl.pending_state) {
+        int width = window->wl.pending.width, height = window->wl.pending.height;
+        set_csd_window_geometry(window, &width, &height);
+        resized = dispatchChangesAfterConfigure(window, width, height);
+        if (window->wl.decorations.serverSide) {
+            free_csd_surfaces(window);
+        } else {
+            ensure_csd_resources(window);
+        }
+        debug("final window content size: %dx%d resized: %d\n", width, height, resized);
+    }
+
+    inform_compositor_of_window_geometry(window, "configure");
+
+    // if a resize happened there will be a commit at the next render frame so
+    // dont commit here, GNOME doesnt like it and its not really needed anyway
+    if (!resized) wl_surface_commit(window->wl.surface);
+    window->wl.pending_state = 0;
 }
 
 static const struct xdg_surface_listener xdgSurfaceListener = {
@@ -764,6 +788,7 @@ int _glfwPlatformCreateWindow(_GLFWwindow* window,
     initialize_csd_metrics(window);
     window->wl.transparent = fbconfig->transparent;
     strncpy(window->wl.appId, wndconfig->wl.appId, sizeof(window->wl.appId));
+    window->swaps_disallowed = true;
 
     if (!createSurface(window, wndconfig))
         return false;
@@ -904,19 +929,19 @@ void _glfwPlatformSetWindowPos(_GLFWwindow* window UNUSED, int xpos UNUSED, int
 void _glfwPlatformGetWindowSize(_GLFWwindow* window, int* width, int* height)
 {
     if (width)
-        *width = window->wl.current.width;
+        *width = window->wl.width;
     if (height)
-        *height = window->wl.current.height;
+        *height = window->wl.height;
 }
 
 void _glfwPlatformSetWindowSize(_GLFWwindow* window, int width, int height)
 {
-    if (width != window->wl.current.width || height != window->wl.current.height) {
+    if (width != window->wl.width || height != window->wl.height) {
         window->wl.user_requested_content_size.width = width;
         window->wl.user_requested_content_size.height = height;
         int32_t w = 0, h = 0;
         set_csd_window_geometry(window, &w, &h);
-        window->wl.current.width = w; window->wl.current.height = h;
+        window->wl.width = w; window->wl.height = h;
         resizeFramebuffer(window);
         ensure_csd_resources(window);
         wl_surface_commit(window->wl.surface);
@@ -973,7 +998,7 @@ void _glfwPlatformGetWindowFrameSize(_GLFWwindow* window,
     if (window->decorated && !window->monitor && !window->wl.decorations.serverSide)
     {
         if (top)
-            *top = window->wl.decorations.metrics.top;
+            *top = window->wl.decorations.metrics.top - window->wl.decorations.metrics.visible_titlebar_height;
         if (left)
             *left = window->wl.decorations.metrics.width;
         if (right)
@@ -1042,6 +1067,8 @@ void _glfwPlatformHideWindow(_GLFWwindow* window)
         xdg_surface_destroy(window->wl.xdg.surface);
         window->wl.xdg.toplevel = NULL;
         window->wl.xdg.surface = NULL;
+        window->wl.surface_configured_once = false;
+        window->swaps_disallowed = true;
     }
     window->wl.visible = false;
 }
@@ -1378,6 +1405,7 @@ static void lockPointer(_GLFWwindow* window)
     window->wl.pointerLock.relativePointer = relativePointer;
     window->wl.pointerLock.lockedPointer = lockedPointer;
 
+    debug("Calling wl_pointer_set_cursor in lockPointer with surface: %p\n", NULL);
     wl_pointer_set_cursor(_glfw.wl.pointer, _glfw.wl.serial,
                           NULL, 0, 0);
 }
@@ -1414,6 +1442,7 @@ void _glfwPlatformSetCursor(_GLFWwindow* window, _GLFWcursor* cursor)
     }
     else if (window->cursorMode == GLFW_CURSOR_HIDDEN)
     {
+        debug("Calling wl_pointer_set_cursor in _glfwPlatformSetCursor with surface: %p\n", NULL);
         wl_pointer_set_cursor(_glfw.wl.pointer, _glfw.wl.serial, NULL, 0, 0);
     }
 }

kittens/ask/main.py

@@ -2,10 +2,11 @@
 # License: GPL v3 Copyright: 2018, Kovid Goyal <kovid at kovidgoyal.net>
 
 import os
+import re
 import sys
 from contextlib import suppress
 from typing import (
-    TYPE_CHECKING, Callable, Dict, List, NamedTuple, Optional, Tuple
+    TYPE_CHECKING, Callable, Dict, Iterator, List, NamedTuple, Optional, Tuple
 )
 
 from kitty.cli import parse_args
@@ -16,11 +17,12 @@ from kitty.typing import BossType, KeyEventType, TypedDict
 from kitty.utils import ScreenSize
 
 from ..tui.handler import Handler, result_handler
-from ..tui.loop import Loop, MouseEvent
+from ..tui.loop import Loop, MouseEvent, debug
 from ..tui.operations import MouseTracking, alternate_screen, styled
 
 if TYPE_CHECKING:
     import readline
+    debug
 else:
     readline = None
 
@@ -74,7 +76,7 @@ class HistoryCompleter:
 def option_text() -> str:
     return '''\
 --type -t
-choices=line,yesno,choices
+choices=line,yesno,choices,password
 default=line
 Type of input. Defaults to asking for a line of text.
 
@@ -92,17 +94,31 @@ be used for completions and via the browse history readline bindings.
 --choice -c
 type=list
 dest=choices
-A choice for the choices type. Every choice has the syntax: letter:text Where
+A choice for the choices type. Can be specified multiple times. Every choice has
-letter is the accelerator key and text is the corresponding text.  There can be
+the syntax: ``letter[;color]:text``. Where :italic:`letter` is the accelerator key
-an optional color specification after the letter to indicate what color it should
+and :italic:`text` is the corresponding text. There can be an optional color
-be.
+specification after the letter to indicate what color it should be.
-For example: y:Yes and n;red:No
+For example: :code:`y:Yes` and :code:`n;red:No`
 
 
 --default -d
-A default choice or text. If unspecified, it is "y" for :code:`yesno`, the first choice
+A default choice or text. If unspecified, it is :code:`y` for the type
-for :code:`choices` and empty for others. The default choice is selected when the user
+:code:`yesno`, the first choice for :code:`choices` and empty for others types.
-presses the Enter key.
+The default choice is selected when the user presses the :kbd:`Enter` key.
+
+
+--prompt -p
+default="> "
+The prompt to use when inputting a line of text or a password.
+
+
+--unhide-key
+default=u
+The key to be pressed to unhide hidden text
+
+
+--hidden-text-placeholder
+The text in the message to be replaced by hidden text. The hidden text is read via STDIN.
 '''
 
 
@@ -140,10 +156,63 @@ def extra_for(width: int, screen_width: int) -> int:
     return max(0, screen_width - width) // 2 + 1
 
 
-class Choose(Handler):
+class Password(Handler):
+
+    def __init__(self, cli_opts: AskCLIOptions, prompt: str, is_password: bool = True, initial_text: str = '') -> None:
+        self.cli_opts = cli_opts
+        self.prompt = prompt
+        self.initial_text = initial_text
+        from kittens.tui.line_edit import LineEdit
+        self.line_edit = LineEdit(is_password=is_password)
+
+    def initialize(self) -> None:
+        self.cmd.set_cursor_shape('beam')
+        if self.initial_text:
+            self.line_edit.on_text(self.initial_text, True)
+        self.draw_screen()
+
+    @Handler.atomic_update
+    def draw_screen(self) -> None:
+        self.cmd.clear_screen()
+        if self.cli_opts.message:
+            for line in self.cli_opts.message.splitlines():
+                self.print(line)
+            self.print()
+        self.line_edit.write(self.write, self.prompt)
+
+    def on_text(self, text: str, in_bracketed_paste: bool = False) -> None:
+        self.line_edit.on_text(text, in_bracketed_paste)
+        self.draw_screen()
+
+    def on_key(self, key_event: KeyEventType) -> None:
+        if self.line_edit.on_key(key_event):
+            self.draw_screen()
+            return
+        if key_event.matches('enter'):
+            self.quit_loop(0)
+        if key_event.matches('esc'):
+            self.quit_loop(1)
+
+    def on_resize(self, screen_size: ScreenSize) -> None:
+        self.screen_size = screen_size
+        self.draw_screen()
+
+    def on_interrupt(self) -> None:
+        self.quit_loop(1)
+    on_eot = on_interrupt
+
+    @property
+    def response(self) -> str:
+        if self._tui_loop.return_code == 0:
+            return self.line_edit.current_input
+        return ''
+
+
+class Choose(Handler):  # {{{
     mouse_tracking = MouseTracking.buttons_only
 
     def __init__(self, cli_opts: AskCLIOptions) -> None:
+        self.prefix_style_pat = re.compile(r'(?:\x1b\[[^m]*?m)+')
         self.cli_opts = cli_opts
         self.choices: Dict[str, Choice] = {}
         self.clickable_ranges: Dict[str, List[Range]] = {}
@@ -165,6 +234,18 @@ class Choose(Handler):
         self.response_on_accept = cli_opts.default or ''
         if cli_opts.type in ('yesno', 'choices') and self.response_on_accept not in self.allowed:
             self.response_on_accept = 'y' if cli_opts.type == 'yesno' else tuple(self.choices.keys())[0]
+        self.message = cli_opts.message
+        self.hidden_text_start_pos = self.hidden_text_end_pos = -1
+        self.hidden_text = ''
+        self.replacement_text = t = f'Press {styled(self.cli_opts.unhide_key, fg="green")} or click to show'
+        self.replacement_range = Range(-1, -1, -1)
+        if self.message and self.cli_opts.hidden_text_placeholder:
+            self.hidden_text_start_pos = self.message.find(self.cli_opts.hidden_text_placeholder)
+            if self.hidden_text_start_pos > -1:
+                self.hidden_text = sys.stdin.read().rstrip()
+                self.hidden_text_end_pos = self.hidden_text_start_pos + len(t)
+                suffix = self.message[self.hidden_text_start_pos + len(self.cli_opts.hidden_text_placeholder):]
+                self.message = self.message[:self.hidden_text_start_pos] + t + suffix
 
     def initialize(self) -> None:
         self.cmd.set_cursor_visible(False)
@@ -173,24 +254,35 @@ class Choose(Handler):
     def finalize(self) -> None:
         self.cmd.set_cursor_visible(True)
 
-    def draw_long_text(self, text: str) -> int:
+    def draw_long_text(self, text: str) -> Iterator[str]:
-        y = 0
+        if not text:
+            yield ''
+            return
         width = self.screen_size.cols - 2
+        m = self.prefix_style_pat.match(text)
+        prefix = m.group() if m else ''
         while text:
             t, text = truncate_at_space(text, width)
             t = t.strip()
-            self.print(' ' * extra_for(wcswidth(t), width), styled(t, bold=True), sep='')
+            yield ' ' * extra_for(wcswidth(t), width) + styled(prefix + t, bold=True)
-            y += 1
-        return y
 
     @Handler.atomic_update
     def draw_screen(self) -> None:
         self.cmd.clear_screen()
-        y = max(0, self.screen_size.rows // 2 - 2)
+        msg_lines: List[str] = []
+        if self.message:
+            for line in self.message.splitlines():
+                msg_lines.extend(self.draw_long_text(line))
+        y = self.screen_size.rows - len(msg_lines)
+        y = max(0, (y // 2) - 2)
         self.print(end='\r\n'*y)
-        if self.cli_opts.message:
+        for line in msg_lines:
-            for line in self.cli_opts.message.splitlines():
+            if self.replacement_text in line:
-                y += self.draw_long_text(line)
+                idx = line.find(self.replacement_text)
+                x = wcswidth(line[:idx])
+                self.replacement_range = Range(x, x + wcswidth(self.replacement_text), y)
+            self.print(line)
+            y += 1
         if self.screen_size.rows > 2:
             self.print()
             y += 1
@@ -205,7 +297,8 @@ class Choose(Handler):
         current_line_length = 0
         current_line: List[Tuple[str, str]] = []
         lines: List[List[Tuple[str, str]]] = []
-        sep, sep_sz = '  ', 2
+        sep = '  '
+        sep_sz = len(sep) + 2  # for the borders
 
         for choice in choices:
             self.clickable_ranges[choice.letter] = []
@@ -218,7 +311,7 @@ class Choose(Handler):
                 current_line = []
                 current_line_length = 0
             current_line.append((choice.letter, text))
-            current_line_length += sz
+            current_line_length += sz + sep_sz
         if current_line:
             lines.append(current_line)
 
@@ -257,10 +350,12 @@ class Choose(Handler):
             self.print(' ' * offset, line, sep='', end='' if is_last else '\r\n')
             y += 1
 
+        self.cmd.set_line_wrapping(False)
         for boxed_line in lines:
             print_line(top, *boxed_line)
             print_line(middle, *boxed_line)
             print_line(bottom, *boxed_line, is_last=boxed_line is lines[-1])
+        self.cmd.set_line_wrapping(True)
 
     def draw_choice(self, y: int) -> None:
         if y + 3 <= self.screen_size.rows:
@@ -316,6 +411,14 @@ class Choose(Handler):
             self.quit_loop(0)
         elif self.cli_opts.type == 'yesno':
             self.on_interrupt()
+        elif self.hidden_text and text == self.cli_opts.unhide_key:
+            self.unhide()
+
+    def unhide(self) -> None:
+        if self.hidden_text and self.message:
+            self.message = self.message[:self.hidden_text_start_pos] + self.hidden_text + self.message[self.hidden_text_end_pos:]
+            self.hidden_text = ''
+            self.draw_screen()
 
     def on_key(self, key_event: KeyEventType) -> None:
         if key_event.matches('esc'):
@@ -331,6 +434,8 @@ class Choose(Handler):
                     self.response = letter
                     self.quit_loop(0)
                     return
+        if self.hidden_text and self.replacement_range.has_point(ev.cell_x, ev.cell_y):
+            self.unhide()
 
     def on_resize(self, screen_size: ScreenSize) -> None:
         self.screen_size = screen_size
@@ -339,6 +444,7 @@ class Choose(Handler):
     def on_interrupt(self) -> None:
         self.quit_loop(1)
     on_eot = on_interrupt
+# }}}
 
 
 def main(args: List[str]) -> Response:
@@ -352,7 +458,7 @@ def main(args: List[str]) -> Response:
     except SystemExit as e:
         if e.code != 0:
             print(e.args[0])
-            input('Press enter to quit...')
+            input('Press Enter to quit')
         raise SystemExit(e.code)
 
     if cli_opts.type in ('yesno', 'choices'):
@@ -361,6 +467,15 @@ def main(args: List[str]) -> Response:
         loop.loop(handler)
         return {'items': items, 'response': handler.response}
 
+    prompt = cli_opts.prompt
+    if prompt[0] == prompt[-1] and prompt[0] in '\'"':
+        prompt = prompt[1:-1]
+    if cli_opts.type == 'password':
+        loop = Loop()
+        phandler = Password(cli_opts, prompt)
+        loop.loop(phandler)
+        return {'items': items, 'response': phandler.response}
+
     import readline as rl
     readline = rl
     from kitty.shell import init_readline
@@ -371,7 +486,6 @@ def main(args: List[str]) -> Response:
         if cli_opts.message:
             print(styled(cli_opts.message, bold=True))
 
-        prompt = '> '
         with suppress(KeyboardInterrupt, EOFError):
             if cli_opts.default:
                 def prefill_text() -> None:

kittens/broadcast/main.py

@@ -99,7 +99,7 @@ class Broadcast(Handler):
 
 
 OPTIONS = (MATCH_WINDOW_OPTION + '\n\n' + MATCH_TAB_OPTION.replace('--match -m', '--match-tab -t')).format
-help_text = 'Broadcast typed text to all kitty windows. By default text is sent to all windows, unless one of the matching options is specified'
+help_text = 'Broadcast typed text to kitty windows. By default text is sent to all windows, unless one of the matching options is specified'
 usage = '[initial text to send ...]'
 
 

kittens/choose/main.c

@@ -231,11 +231,11 @@ static PyMethodDef module_methods[] = {
 };
 
 static struct PyModuleDef module = {
-   .m_base = PyModuleDef_HEAD_INIT,
+    .m_base = PyModuleDef_HEAD_INIT,
-   .m_name = "subseq_matcher",   /* name of module */
+    .m_name = "subseq_matcher",   /* name of module */
-   .m_doc = NULL,
+    .m_doc = NULL,
-   .m_size = -1,
+    .m_size = -1,
-   .m_methods = module_methods
+    .m_methods = module_methods
 };
 
 EXPORTED PyMODINIT_FUNC

kittens/clipboard/main.py

@@ -1,63 +1,27 @@
 #!/usr/bin/env python3
 # License: GPL v3 Copyright: 2018, Kovid Goyal <kovid at kovidgoyal.net>
 
+import codecs
+import io
 import os
+import select
 import sys
 from typing import List, NoReturn, Optional
 
 from kitty.cli import parse_args
 from kitty.cli_stub import ClipboardCLIOptions
+from kitty.fast_data_types import parse_input_from_terminal
 
-from ..tui.handler import Handler
+from ..tui.operations import (
-from ..tui.loop import Loop
+    raw_mode, request_from_clipboard, write_to_clipboard
-
+)
-
-class Clipboard(Handler):
-
-    def __init__(self, data_to_send: Optional[bytes], args: ClipboardCLIOptions):
-        self.args = args
-        self.clipboard_contents: Optional[str] = None
-        self.data_to_send = data_to_send
-        self.quit_on_write = False
-
-    def initialize(self) -> None:
-        if self.data_to_send is not None:
-            self.cmd.write_to_clipboard(self.data_to_send, self.args.use_primary)
-        if not self.args.get_clipboard:
-            if self.args.wait_for_completion:
-                # ask kitty for the TN terminfo capability and
-                # only quit after a response is received
-                self.print('\x1bP+q544e\x1b\\', end='')
-                self.print('Waiting for completion...')
-                return
-            self.quit_on_write = True
-            return
-        self.cmd.request_from_clipboard(self.args.use_primary)
-
-    def on_writing_finished(self) -> None:
-        if self.quit_on_write:
-            self.quit_loop(0)
-
-    def on_clipboard_response(self, text: str, from_primary: bool = False) -> None:
-        self.clipboard_contents = text
-        self.quit_loop(0)
-
-    def on_capability_response(self, name: str, val: str) -> None:
-        self.quit_loop(0)
-
-    def on_interrupt(self) -> None:
-        self.quit_loop(1)
-
-    def on_eot(self) -> None:
-        self.quit_loop(1)
-
 
 OPTIONS = r'''
 --get-clipboard
 default=False
 type=bool-set
 Output the current contents of the clipboard to STDOUT. Note that by default
-kitty will prompt you asking to allow access to the clipboard. Can be controlled
+kitty will prompt for permission to access the clipboard. Can be controlled
 by :opt:`clipboard_control`.
 
 
@@ -84,6 +48,62 @@ popup, see :opt:`clipboard_control` for details.
 '''
 
 usage = ''
+got_capability_response = False
+got_clipboard_response = False
+clipboard_contents = ''
+clipboard_from_primary = False
+
+
+def ignore(x: str) -> None:
+    pass
+
+
+def on_text(x: str) -> None:
+    if '\x03' in x:
+        raise KeyboardInterrupt()
+    if '\x04' in x:
+        raise EOFError()
+
+
+def on_dcs(dcs: str) -> None:
+    global got_capability_response
+    if dcs.startswith('1+r'):
+        got_capability_response = True
+
+
+def on_osc(osc: str) -> None:
+    global clipboard_contents, clipboard_from_primary, got_clipboard_response
+    idx = osc.find(';')
+    if idx <= 0:
+        return
+    q = osc[:idx]
+    if q == '52':
+        got_clipboard_response = True
+        widx = osc.find(';', idx + 1)
+        if widx < idx:
+            clipboard_from_primary = osc.find('p', idx + 1) > -1
+            clipboard_contents = ''
+        else:
+            from base64 import standard_b64decode
+            clipboard_from_primary = osc.find('p', idx+1, widx) > -1
+            data = memoryview(osc.encode('ascii'))
+            clipboard_contents = standard_b64decode(data[widx+1:]).decode('utf-8')
+
+
+def wait_loop(tty_fd: int) -> None:
+    os.set_blocking(tty_fd, False)
+    decoder = codecs.getincrementaldecoder('utf-8')('ignore')
+    with raw_mode(tty_fd):
+        buf = ''
+        while not got_capability_response and not got_clipboard_response:
+            rd = select.select([tty_fd], [], [])[0]
+            if rd:
+                raw = os.read(tty_fd, io.DEFAULT_BUFFER_SIZE)
+                if not raw:
+                    raise EOFError()
+                data = decoder.decode(raw)
+                buf = (buf + data) if buf else data
+                buf = parse_input_from_terminal(on_text, on_dcs, ignore, on_osc, ignore, ignore, buf, False)
 
 
 def main(args: List[str]) -> NoReturn:
@@ -93,14 +113,34 @@ def main(args: List[str]) -> NoReturn:
     data: Optional[bytes] = None
     if not sys.stdin.isatty():
         data = sys.stdin.buffer.read()
-        sys.stdin = open(os.ctermid())
+    wait_for_capability_response = False
-    loop = Loop()
+    data_to_write = []
-    handler = Clipboard(data, cli_opts)
+    if data:
-    loop.loop(handler)
+        data_to_write.append(write_to_clipboard(data, cli_opts.use_primary).encode('ascii'))
-    if loop.return_code == 0 and handler.clipboard_contents:
+        if not cli_opts.get_clipboard and cli_opts.wait_for_completion:
-        sys.stdout.write(handler.clipboard_contents)
+            data_to_write.append(b'\x1bP+q544e\x1b\\')
-        sys.stdout.flush()
+            wait_for_capability_response = True
-    raise SystemExit(loop.return_code)
+    if cli_opts.get_clipboard:
+        data_to_write.append(request_from_clipboard(cli_opts.use_primary).encode('ascii'))
+        wait_for_capability_response = True
+    tty_fd = os.open(os.ctermid(), os.O_RDWR | os.O_CLOEXEC)
+    retcode = 0
+    with open(tty_fd, 'wb', closefd=True) as ttyf:
+        for x in data_to_write:
+            ttyf.write(x)
+        ttyf.flush()
+        if wait_for_capability_response:
+            try:
+                wait_loop(tty_fd)
+            except KeyboardInterrupt:
+                sys.excepthook = lambda *a: None
+                raise
+            except EOFError:
+                retcode = 1
+    if clipboard_contents:
+        print(end=clipboard_contents)
+
+    raise SystemExit(retcode)
 
 
 if __name__ == '__main__':

kittens/diff/collect.py

@@ -4,10 +4,14 @@
 import os
 import re
 from contextlib import suppress
+from fnmatch import fnmatch
 from functools import lru_cache
 from hashlib import md5
+from typing import (
+    TYPE_CHECKING, Dict, Iterator, List, Optional, Sequence, Set, Tuple, Union
+)
+
 from kitty.guess_mime_type import guess_type
-from typing import TYPE_CHECKING, Dict, List, Set, Optional, Iterator, Tuple, Union
 
 if TYPE_CHECKING:
     from .highlight import DiffHighlight  # noqa
@@ -37,6 +41,8 @@ class Segment:
 
 class Collection:
 
+    ignore_names: Tuple[str, ...] = ()
+
     def __init__(self) -> None:
         self.changes: Dict[str, str] = {}
         self.renames: Dict[str, str] = {}
@@ -105,22 +111,34 @@ def resolve_remote_name(path: str, default: str) -> str:
     return default
 
 
+def allowed_items(items: Sequence[str], ignore_patterns: Sequence[str]) -> Iterator[str]:
+    for name in items:
+        for pat in ignore_patterns:
+            if fnmatch(name, pat):
+                break
+        else:
+            yield name
+
+
+def walk(base: str, names: Set[str], pmap: Dict[str, str], ignore_names: Tuple[str, ...]) -> None:
+    for dirpath, dirnames, filenames in os.walk(base):
+        dirnames[:] = allowed_items(dirnames, ignore_names)
+        for filename in allowed_items(filenames, ignore_names):
+            path = os.path.abspath(os.path.join(dirpath, filename))
+            path_name_map[path] = name = os.path.relpath(path, base)
+            names.add(name)
+            pmap[name] = path
+
+
 def collect_files(collection: Collection, left: str, right: str) -> None:
     left_names: Set[str] = set()
     right_names: Set[str] = set()
     left_path_map: Dict[str, str] = {}
     right_path_map: Dict[str, str] = {}
 
-    def walk(base: str, names: Set[str], pmap: Dict[str, str]) -> None:
+    walk(left, left_names, left_path_map, collection.ignore_names)
-        for dirpath, dirnames, filenames in os.walk(base):
+    walk(right, right_names, right_path_map, collection.ignore_names)
-            for filename in filenames:
-                path = os.path.abspath(os.path.join(dirpath, filename))
-                path_name_map[path] = name = os.path.relpath(path, base)
-                names.add(name)
-                pmap[name] = path
 
-    walk(left, left_names, left_path_map)
-    walk(right, right_names, right_path_map)
     common_names = left_names & right_names
     changed_names = {n for n in common_names if data_for_path(left_path_map[n]) != data_for_path(right_path_map[n])}
     for n in changed_names:

kittens/diff/highlight.py

@@ -161,13 +161,15 @@ def highlight_collection(collection: Collection, aliases: Optional[Dict[str, str
                     if p:
                         is_binary = isinstance(data_for_path(p), bytes)
                         if not is_binary:
-                            jobs[executor.submit(highlight_for_diff, p, aliases)] = p
+                            jobs[executor.submit(highlight_for_diff, p, aliases or {})] = p
         for future in concurrent.futures.as_completed(jobs):
             path = jobs[future]
             try:
                 highlights = future.result()
             except Exception as e:
-                return f'Running syntax highlighting for {path} generated an exception: {e}'
+                import traceback
+                tb = traceback.format_exc()
+                return f'Running syntax highlighting for {path} generated an exception: {e} with traceback:\n{tb}'
             ans[path] = highlights
     return ans
 

kittens/diff/main.py

@@ -293,10 +293,11 @@ class DiffHandler(Handler):
 
     def scroll_lines(self, amt: int = 1) -> None:
         new_pos = max(0, min(self.scroll_pos + amt, self.max_scroll_pos))
+        amt = new_pos - self.scroll_pos
         if new_pos == self.scroll_pos:
             self.cmd.bell()
             return
-        if abs(new_pos - self.scroll_pos) >= self.num_lines - 1:
+        if abs(amt) >= self.num_lines - 1:
             self.scroll_pos = new_pos
             self.draw_screen()
             return
@@ -570,8 +571,8 @@ OPTIONS = partial('''\
 --context
 type=int
 default=-1
-Number of lines of context to show between changes. Negative values
+Number of lines of context to show between changes. Negative values use the
-use the number set in diff.conf
+number set in :file:`diff.conf`.
 
 
 --config
@@ -598,7 +599,7 @@ class ShowWarning:
 
 
 showwarning = ShowWarning()
-help_text = 'Show a side-by-side diff of the specified files/directories. You can also use ssh:hostname:remote-file-path to diff remote files.'
+help_text = 'Show a side-by-side diff of the specified files/directories. You can also use :italic:`ssh:hostname:remote-file-path` to diff remote files.'
 usage = 'file_or_directory_left file_or_directory_right'
 
 
@@ -654,6 +655,7 @@ def main(args: List[str]) -> None:
     opts = init_config(cli_opts)
     set_diff_command(opts.diff_cmd)
     lines_for_path.replace_tab_by = opts.replace_tab_by
+    Collection.ignore_names = tuple(opts.ignore_name)
     left, right = map(get_remote_file, (left, right))
     if os.path.isdir(left) != os.path.isdir(right):
         raise SystemExit('The items to be diffed should both be either directories or files. Comparing a directory to a file is not valid.')

kittens/diff/options/definition.py

@@ -24,8 +24,8 @@ agr('diff', 'Diffing')
 opt('syntax_aliases', 'pyj:py pyi:py recipe:py',
     option_type='syntax_aliases',
     long_text='''
-File extension aliases for syntax highlight For example, to syntax highlight
+File extension aliases for syntax highlight. For example, to syntax highlight
-:file:`file.xyz` as :file:`file.abc` use a setting of :code:`xyz:abc`
+:file:`file.xyz` as :file:`file.abc` use a setting of :code:`xyz:abc`.
 '''
     )
 
@@ -37,8 +37,9 @@ opt('num_context_lines', '3',
 opt('diff_cmd', 'auto',
     long_text='''
 The diff command to use. Must contain the placeholder :code:`_CONTEXT_` which
-will be replaced by the number of lines of context. The default is to search the
+will be replaced by the number of lines of context. The default special value
-system for either git or diff and use that, if found.
+:code:`auto` is to search the system for either :program:`git` or
+:program:`diff` and use that, if found.
 '''
     )
 
@@ -46,6 +47,21 @@ opt('replace_tab_by', '\\x20\\x20\\x20\\x20',
     option_type='python_string',
     long_text='The string to replace tabs with. Default is to use four spaces.'
     )
+
+opt('+ignore_name', '',
+    option_type='store_multiple',
+    add_to_default=False,
+    long_text='''
+A glob pattern that is matched against only the filename of files and directories. Matching
+files and directories are ignored when scanning the filesystem to look for files to diff.
+Can be specified multiple times to use multiple patterns. For example::
+
+    ignore_name .git
+    ignore_name *~
+    ignore_name *.pyc
+''',
+    )
+
 egr()  # }}}
 
 # colors {{{

kittens/diff/options/parse.py

@@ -1,7 +1,7 @@
 # generated by gen-config.py DO NOT edit
 
 import typing
-from kittens.diff.options.utils import parse_map, syntax_aliases
+from kittens.diff.options.utils import parse_map, store_multiple, syntax_aliases
 from kitty.conf.utils import merge_dicts, positive_int, python_string, to_color, to_color_or_none
 
 
@@ -37,6 +37,10 @@ class Parser:
     def hunk_margin_bg(self, val: str, ans: typing.Dict[str, typing.Any]) -> None:
         ans['hunk_margin_bg'] = to_color(val)
 
+    def ignore_name(self, val: str, ans: typing.Dict[str, typing.Any]) -> None:
+        for k, v in store_multiple(val, ans["ignore_name"]):
+            ans["ignore_name"][k] = v
+
     def margin_bg(self, val: str, ans: typing.Dict[str, typing.Any]) -> None:
         ans['margin_bg'] = to_color(val)
 
@@ -89,11 +93,12 @@ class Parser:
 
 def create_result_dict() -> typing.Dict[str, typing.Any]:
     return {
+        'ignore_name': {},
         'map': [],
     }
 
 
-actions = frozenset(('map',))
+actions: typing.FrozenSet[str] = frozenset(('map',))
 
 
 def merge_result_dicts(defaults: typing.Dict[str, typing.Any], vals: typing.Dict[str, typing.Any]) -> typing.Dict[str, typing.Any]:

kittens/diff/options/types.py

@@ -20,6 +20,7 @@ option_names = (  # {{{
  'highlight_removed_bg',
  'hunk_bg',
  'hunk_margin_bg',
+ 'ignore_name',
  'map',
  'margin_bg',
  'margin_fg',
@@ -64,6 +65,7 @@ class Options:
     syntax_aliases: typing.Dict[str, str] = {'pyj': 'py', 'pyi': 'py', 'recipe': 'py'}
     title_bg: Color = Color(255, 255, 255)
     title_fg: Color = Color(0, 0, 0)
+    ignore_name: typing.Dict[str, str] = {}
     map: typing.List[typing.Tuple[kitty.types.ParsedShortcut, kitty.conf.utils.KeyAction]] = []
     key_definitions: KittensKeyMap = {}
     config_paths: typing.Tuple[str, ...] = ()
@@ -116,6 +118,7 @@ class Options:
 
 
 defaults = Options()
+defaults.ignore_name = {}
 defaults.map = [
     # quit
     (ParsedShortcut(mods=0, key_name='q'), KeyAction('quit')),  # noqa

kittens/diff/options/utils.py

@@ -3,7 +3,7 @@
 # License: GPLv3 Copyright: 2021, Kovid Goyal <kovid at kovidgoyal.net>
 
 
-from typing import Any, Dict, Iterable, Tuple, Union
+from typing import Any, Container, Dict, Iterable, Tuple, Union
 
 from kitty.conf.utils import (
     KeyFuncWrapper, KittensKeyDefinition, parse_kittens_key
@@ -58,6 +58,12 @@ def syntax_aliases(raw: str) -> Dict[str, str]:
     return ans
 
 
+def store_multiple(val: str, current_val: Container[str]) -> Iterable[Tuple[str, str]]:
+    val = val.strip()
+    if val not in current_val:
+        yield val, val
+
+
 def parse_map(val: str) -> Iterable[KittensKeyDefinition]:
     x = parse_kittens_key(val, func_with_args.args_funcs)
     if x is not None:

kittens/diff/patch.py

@@ -153,7 +153,7 @@ class Hunk:
         if c.left_start + c.left_count != self.left_start + self.left_count:
             raise ValueError(f'Left side line mismatch {c.left_start + c.left_count} != {self.left_start + self.left_count}')
         if c.right_start + c.right_count != self.right_start + self.right_count:
-            raise ValueError(f'Left side line mismatch {c.right_start + c.right_count} != {self.right_start + self.right_count}')
+            raise ValueError(f'Right side line mismatch {c.right_start + c.right_count} != {self.right_start + self.right_count}')
         for c in self.chunks:
             c.finalize()
 
@@ -200,7 +200,7 @@ def parse_patch(raw: str) -> Patch:
         else:
             if current_hunk is None:
                 continue
-            q = line[0]
+            q = line[0] if line else ''
             if q == '+':
                 current_hunk.add_line()
             elif q == '-':

kittens/diff/render.py

@@ -36,6 +36,8 @@ def images_supported() -> bool:
 
 class Ref:
 
+    __slots__: Tuple[str, ...] = ()
+
     def __setattr__(self, name: str, value: object) -> None:
         raise AttributeError("can't set attribute")
 

kittens/diff/speedup.c

@@ -187,11 +187,11 @@ static PyMethodDef module_methods[] = {
 };
 
 static struct PyModuleDef module = {
-   .m_base = PyModuleDef_HEAD_INIT,
+    .m_base = PyModuleDef_HEAD_INIT,
-   .m_name = "diff_speedup",   /* name of module */
+    .m_name = "diff_speedup",   /* name of module */
-   .m_doc = NULL,
+    .m_doc = NULL,
-   .m_size = -1,
+    .m_size = -1,
-   .m_methods = module_methods
+    .m_methods = module_methods
 };
 
 EXPORTED PyMODINIT_FUNC

kittens/hints/main.py

@@ -9,14 +9,14 @@ from functools import lru_cache
 from gettext import gettext as _
 from itertools import repeat
 from typing import (
-    Any, Callable, Dict, Generator, Iterable, List, Optional, Pattern,
+    Any, Callable, Dict, Generator, Iterable, Iterator, List, Optional,
-    Sequence, Set, Tuple, Type, cast
+    Pattern, Sequence, Set, Tuple, Type, cast
 )
 
 from kitty.cli import parse_args
 from kitty.cli_stub import HintsCLIOptions
 from kitty.constants import website_url
-from kitty.fast_data_types import get_options, set_clipboard_string
+from kitty.fast_data_types import get_options, set_clipboard_string, wcswidth
 from kitty.key_encoding import KeyEvent
 from kitty.typing import BossType, KittyCommonOpts
 from kitty.utils import (
@@ -27,6 +27,7 @@ from kitty.utils import (
 from ..tui.handler import Handler, result_handler
 from ..tui.loop import Loop
 from ..tui.operations import faint, styled
+from ..tui.utils import report_error, report_unhandled_error
 
 
 @lru_cache()
@@ -43,6 +44,7 @@ DEFAULT_HINT_ALPHABET = string.digits + string.ascii_lowercase
 DEFAULT_REGEX = r'(?m)^\s*(.+)\s*$'
 FILE_EXTENSION = r'\.(?:[a-zA-Z0-9]{2,7}|[ahcmo])(?!\.)'
 PATH_REGEX = fr'(?:\S*?/[\r\S]+)|(?:\S[\r\S]*{FILE_EXTENSION})\b'
+DEFAULT_LINENUM_REGEX = fr'(?P<path>{PATH_REGEX}):(?P<line>\d+)'
 
 
 class Mark:
@@ -63,6 +65,10 @@ class Mark:
         self.is_hyperlink = is_hyperlink
         self.group_id = group_id
 
+    def __repr__(self) -> str:
+        return (f'Mark(index={self.index!r}, start={self.start!r}, end={self.end!r},'
+                f' text={self.text!r}, groupdict={self.groupdict!r}, is_hyperlink={self.is_hyperlink!r}, group_id={self.group_id!r})')
+
 
 @lru_cache(maxsize=2048)
 def encode_hint(num: int, alphabet: str) -> str:
@@ -117,6 +123,9 @@ def render(text: str, current_input: str, all_marks: Sequence[Mark], ignore_mark
 
 class Hints(Handler):
 
+    use_alternate_screen = False  # disabled to avoid screen being blanked at exit causing flicker
+    overlay_ready_report_needed = True
+
     def __init__(self, text: str, all_marks: Sequence[Mark], index_map: Dict[int, Mark], args: HintsCLIOptions):
         self.text, self.index_map = text, index_map
         self.alphabet = args.alphabet or DEFAULT_HINT_ALPHABET
@@ -221,14 +230,14 @@ class Hints(Handler):
         self.write(self.current_text)
 
 
-def regex_finditer(pat: 'Pattern[str]', minimum_match_length: int, text: str) -> Generator[Tuple[int, int, Dict[str, str]], None, None]:
+def regex_finditer(pat: 'Pattern[str]', minimum_match_length: int, text: str) -> Iterator[Tuple[int, int, 're.Match[str]']]:
     has_named_groups = bool(pat.groupindex)
     for m in pat.finditer(text):
         s, e = m.span(0 if has_named_groups else pat.groups)
         while e > s + 1 and text[e-1] == '\0':
             e -= 1
         if e - s >= minimum_match_length:
-            yield s, e, m.groupdict()
+            yield s, e, m
 
 
 closing_bracket_map = {'(': ')', '[': ']', '{': '}', '<': '>', '*': '*', '"': '"', "'": "'", "“": "”", "‘": "’"}
@@ -314,16 +323,22 @@ def ip(text: str, s: int, e: int) -> Tuple[int, int]:
     return s, e
 
 
-def mark(pattern: str, post_processors: Iterable[PostprocessorFunc], text: str, args: HintsCLIOptions) -> Generator[Mark, None, None]:
+def mark(pattern: str, post_processors: Iterable[PostprocessorFunc], text: str, args: HintsCLIOptions) -> Iterator[Mark]:
     pat = re.compile(pattern)
-    for idx, (s, e, groupdict) in enumerate(regex_finditer(pat, args.minimum_match_length, text)):
+    sanitize_pat = re.compile('[\r\n\0]')
+    for idx, (s, e, match_object) in enumerate(regex_finditer(pat, args.minimum_match_length, text)):
         try:
             for func in post_processors:
                 s, e = func(text, s, e)
         except InvalidMatch:
             continue
-
+        groupdict = match_object.groupdict()
-        mark_text = re.sub('[\r\n\0]', '', text[s:e])
+        for group_name in groupdict:
+            group_idx = pat.groupindex[group_name]
+            gs, ge = match_object.span(group_idx)
+            gs, ge = max(gs, s), min(ge, e)
+            groupdict[group_name] = sanitize_pat.sub('', text[gs:ge])
+        mark_text = sanitize_pat.sub('', text[s:e])
         yield Mark(idx, s, e, mark_text, groupdict)
 
 
@@ -396,7 +411,10 @@ def convert_text(text: str, cols: int) -> str:
             appended = False
             for line in full_line.split('\r'):
                 if line:
-                    lines.append(line.ljust(cols, '\0'))
+                    line_sz = wcswidth(line)
+                    if line_sz < cols:
+                        line += '\0' * (cols - line_sz)
+                    lines.append(line)
                     lines.append('\r')
                     appended = True
             if appended:
@@ -416,7 +434,7 @@ def parse_input(text: str) -> str:
 def linenum_marks(text: str, args: HintsCLIOptions, Mark: Type[Mark], extra_cli_args: Sequence[str], *a: Any) -> Generator[Mark, None, None]:
     regex = args.regex
     if regex == DEFAULT_REGEX:
-        regex = fr'(?P<path>{PATH_REGEX}):(?P<line>\d+)'
+        regex = DEFAULT_LINENUM_REGEX
     yield from mark(regex, [brackets, quotes], text, args)
 
 
@@ -500,7 +518,7 @@ def run(args: HintsCLIOptions, text: str, extra_cli_args: Sequence[str] = ()) ->
             all_marks = tuple(mark(pattern, post_processors, text, args))
         if not all_marks:
             none_of = {'url': 'URLs', 'hyperlink': 'hyperlinks'}.get(args.type, 'matches')
-            input(_('No {} found, press Enter to quit.').format(none_of))
+            report_error(_('No {} found.').format(none_of))
             return None
 
         largest_index = all_marks[-1].index
@@ -512,11 +530,7 @@ def run(args: HintsCLIOptions, text: str, extra_cli_args: Sequence[str] = ()) ->
                 m.index = largest_index - m.index + offset
         index_map = {m.index: m for m in all_marks}
     except Exception:
-        import traceback
+        report_unhandled_error()
-        traceback.print_exc()
-        input('Press Enter to quit.')
-        raise SystemExit(1)
-
     return run_loop(args, text, all_marks, index_map, extra_cli_args)
 
 
@@ -525,12 +539,27 @@ OPTIONS = r'''
 --program
 type=list
 What program to use to open matched text. Defaults to the default open program
-for the operating system. Use a value of :file:`-` to paste the match into the
+for the operating system. Various special values are supported:
-terminal window instead. A value of :file:`@` will copy the match to the
+
-clipboard. A value of :file:`*` will copy the match to the primary selection
+:code:`-`
-(on systems that support primary selections). A value of :file:`default` will
+    paste the match into the terminal window.
-run the default open program. Can be specified multiple times to run multiple
+
-programs.
+:code:`@`
+    copy the match to the clipboard
+
+:code:`*`
+    copy the match to the primary selection (on systems that support primary selections)
+
+:code:`default`
+    run the default open program.
+
+:code:`launch`
+    run :doc:`/launch` to open the program in a new kitty tab, window, overlay, etc.
+    For example::
+
+        --program "launch --type=tab vim"
+
+Can be specified multiple times to run multiple programs.
 
 
 --type
@@ -538,22 +567,22 @@ default=url
 choices=url,regex,path,line,hash,word,linenum,hyperlink,ip
 The type of text to search for. A value of :code:`linenum` is special, it looks
 for error messages using the pattern specified with :option:`--regex`, which
-must have the named groups, :code:`path` and :code:`line`. If not specified,
+must have the named groups: :code:`path` and :code:`line`. If not specified,
 will look for :code:`path:line`. The :option:`--linenum-action` option
 controls where to display the selected error message, other options are ignored.
 
 
 --regex
 default={default_regex}
-The regular expression to use when :option:`kitty +kitten hints --type`=regex.
+The regular expression to use when option :option:`--type` is set to
-The regular expression is in python syntax. If you specify a numbered group in
+:code:`regex`, in python syntax. If you specify a numbered group in the regular
-the regular expression only the group will be matched. This allow you to match
+expression, only the group will be matched. This allow you to match text
-text ignoring a prefix/suffix, as needed. The default expression matches lines.
+ignoring a prefix/suffix, as needed. The default expression matches lines. To
-To match text over multiple lines you should prefix the regular expression with
+match text over multiple lines, you should prefix the regular expression with
 :code:`(?ms)`, which turns on MULTILINE and DOTALL modes for the regex engine.
-If you specify named groups and a :option:`kitty +kitten hints --program` then
+If you specify named groups and a :option:`--program`, then the program will be
-the program will be passed arguments corresponding to each named group of
+passed arguments corresponding to each named group of the form
-the form key=value.
+:code:`key=value`.
 
 
 --linenum-action
@@ -565,22 +594,22 @@ window, :code:`window` a new kitty window, :code:`tab` a new tab,
 :code:`os_window` a new OS window and :code:`background` run in the background.
 The actual action is whatever arguments are provided to the kitten, for
 example:
-:code:`kitty + kitten hints --type=linenum --linenum-action=tab vim +{line} {path}`
+:code:`kitty +kitten hints --type=linenum --linenum-action=tab vim +{line} {path}`
 will open the matched path at the matched line number in vim in
-a new kitty tab. Note that only when using :code:`self` are the special values for
+a new kitty tab. Note that in order to use :option:`--program` to copy or paste
-:option:`kitty +kitten hints --program` to copy/paste the text respected.
+text, you need to use the special value :code:`self`.
 
 
 --url-prefixes
 default=default
-Comma separated list of recognized URL prefixes. Defaults, to
+Comma separated list of recognized URL prefixes. Defaults to the list of
-the list of prefixes defined in kitty.conf.
+prefixes defined by the :opt:`url_prefixes` option in :file:`kitty.conf`.
 
 
 --word-characters
 Characters to consider as part of a word. In addition, all characters marked as
-alphanumeric in the unicode database will be considered as word characters.
+alphanumeric in the Unicode database will be considered as word characters.
-Defaults to the select_by_word_characters setting from kitty.conf.
+Defaults to the :opt:`select_by_word_characters` option from :file:`kitty.conf`.
 
 
 --minimum-match-length
@@ -591,26 +620,26 @@ The minimum number of characters to consider a match.
 
 --multiple
 type=bool-set
-Select multiple matches and perform the action on all of them together at the end.
+Select multiple matches and perform the action on all of them together at the
-In this mode, press :kbd:`Esc` to finish selecting.
+end. In this mode, press :kbd:`Esc` to finish selecting.
 
 
 --multiple-joiner
 default=auto
-String to use to join multiple selections when copying to the clipboard or
+String for joining multiple selections when copying to the clipboard or
-inserting into the terminal. The special strings: "space", "newline", "empty",
+inserting into the terminal. The special values are: :code:`space` - a space
-"json" and "auto" are interpreted as a space character, a newline an empty
+character, :code:`newline` - a newline, :code:`empty` - an empty joiner,
-joiner, a JSON serialized list and an automatic choice, based on the type of
+:code:`json` - a JSON serialized list, :code:`auto` - an automatic choice, based
-text being selected. In addition, integers are interpreted as zero-based
+on the type of text being selected. In addition, integers are interpreted as
-indices into the list of selections. You can use 0 for the first selection and
+zero-based indices into the list of selections. You can use :code:`0` for the
--1 for the last.
+first selection and :code:`-1` for the last.
 
 
 --add-trailing-space
 default=auto
 choices=auto,always,never
-Add trailing space after matched text. Defaults to auto, which adds the space
+Add trailing space after matched text. Defaults to :code:`auto`, which adds the
-when used together with :option:`--multiple`.
+space when used together with :option:`--multiple`.
 
 
 --hints-offset
@@ -621,45 +650,47 @@ greater than or equal to zero are respected.
 
 
 --alphabet
-The list of characters to use for hints. The default is to use numbers and lowercase
+The list of characters to use for hints. The default is to use numbers and
-English alphabets. Specify your preference as a string of characters. Note that
+lowercase English alphabets. Specify your preference as a string of characters.
-unless you specify the hints offset as zero the first match will be highlighted with
+Note that you need to specify the :option:`--hints-offset` as zero to use the
-the second character you specify.
+first character to highlight the first match, otherwise it will start with the
+second character by default.
 
 
 --ascending
 type=bool-set
-Have the hints increase from top to bottom instead of decreasing from top to bottom.
+Make the hints increase from top to bottom, instead of decreasing from top to
+bottom.
 
 
 --hints-foreground-color
 default=black
 type=str
-The foreground color for hints
+The foreground color for hints.
 
 
 --hints-background-color
 default=green
 type=str
-The background color for hints
+The background color for hints.
 
 
 --hints-text-color
 default=gray
 type=str
-The foreground color for text pointed to by the hints
+The foreground color for text pointed to by the hints.
 
 
 --customize-processing
-Name of a python file in the kitty config directory which will be imported to provide
+Name of a python file in the kitty config directory which will be imported to
-custom implementations for pattern finding and performing actions
+provide custom implementations for pattern finding and performing actions
-on selected matches. See {hints_url}
+on selected matches. You can also specify absolute paths to load the script from
-for details. You can also specify absolute paths to load the script from elsewhere.
+elsewhere. See {hints_url} for details.
 
 
 --window-title
-The window title for the hints window, default title is selected based on
+The title for the hints window, default title is based on the type of text being
-the type of text being hinted.
+hinted.
 '''.format(
     default_regex=DEFAULT_REGEX,
     line='{{line}}', path='{{path}}',
@@ -677,9 +708,7 @@ def main(args: List[str]) -> Optional[Dict[str, Any]]:
     text = ''
     if sys.stdin.isatty():
         if '--help' not in args and '-h' not in args:
-            print('You must pass the text to be hinted on STDIN', file=sys.stderr)
+            report_unhandled_error('You must pass the text to be hinted on STDIN')
-            input(_('Press Enter to quit'))
-            return None
     else:
         text = sys.stdin.buffer.read().decode('utf-8')
         sys.stdin = open(os.ctermid())
@@ -687,34 +716,26 @@ def main(args: List[str]) -> Optional[Dict[str, Any]]:
         opts, items = parse_hints_args(args[1:])
     except SystemExit as e:
         if e.code != 0:
-            print(e.args[0], file=sys.stderr)
+            report_unhandled_error(e.args[0])
-            input(_('Press Enter to quit'))
         return None
     if items and not (opts.customize_processing or opts.type == 'linenum'):
-        print('Extra command line arguments present: {}'.format(' '.join(items)), file=sys.stderr)
+        report_unhandled_error('Extra command line arguments present: {}'.format(' '.join(items)))
-        input(_('Press Enter to quit'))
     try:
         return run(opts, text, items)
     except Exception:
-        import traceback
+        report_unhandled_error()
-        traceback.print_exc()
-        input(_('Press Enter to quit'))
     return None
 
 
 def linenum_process_result(data: Dict[str, Any]) -> Tuple[str, int]:
-    pat = re.compile(r':(\d+)$')
+    lnum_pat = re.compile(r'(:\d+)$')
-    for m, g in zip(data['match'], data['groupdicts']):
+    for match, g in zip(data['match'], data['groupdicts']):
-        if m:
+        path, line = g['path'], g['line']
-            path, line = g['path'], g['line']
+        if path and line:
-            # look for trailers on path of the for :number
+            m = lnum_pat.search(path)
-            while True:
+            if m is not None:
-                m = pat.search(path)
+                line = m.group(1)[1:]
-                if m is None:
+                path = path.rpartition(':')[0]
-                    break
-                line = m.group(1)
-                path = path[:-len(m.group())]
-
             return os.path.expanduser(path), int(line)
     return '', -1
 
@@ -752,7 +773,7 @@ def linenum_handle_result(args: List[str], data: Dict[str, Any], target_window_i
             }[action])(*cmd)
 
 
-@result_handler(type_of_input='screen-ansi')
+@result_handler(type_of_input='screen-ansi', has_ready_notification=Hints.overlay_ready_report_needed)
 def handle_result(args: List[str], data: Dict[str, Any], target_window_id: int, boss: BossType) -> None:
     if data['customize_processing']:
         m = load_custom_processor(data['customize_processing'])
@@ -794,12 +815,13 @@ def handle_result(args: List[str], data: Dict[str, Any], target_window_id: int,
         if program == '-':
             w = boss.window_id_map.get(target_window_id)
             if w is not None:
-                w.paste(joined_text())
+                w.paste_text(joined_text())
         elif program == '@':
             set_clipboard_string(joined_text())
         elif program == '*':
             set_primary_selection(joined_text())
         else:
+            from kitty.conf.utils import to_cmdline
             cwd = data['cwd']
             program = get_options().open_url_with if program == 'default' else program
             if text_type == 'hyperlink':
@@ -808,12 +830,20 @@ def handle_result(args: List[str], data: Dict[str, Any], target_window_id: int,
                     if w is not None:
                         w.open_url(m, hyperlink_id=1, cwd=cwd)
             else:
+                launch_args = []
+                if isinstance(program, str) and program.startswith('launch '):
+                    launch_args = to_cmdline(program)
+                    launch_args.insert(1, '--cwd=' + cwd)
                 for m, groupdict in zip(matches, groupdicts):
                     if groupdict:
                         m = []
                         for k, v in groupdict.items():
                             m.append('{}={}'.format(k, v or ''))
-                    boss.open_url(m, program, cwd=cwd)
+                    if launch_args:
+                        w = boss.window_id_map.get(target_window_id)
+                        boss.call_remote_control(active_window=w, args=tuple(launch_args + ([m] if isinstance(m, str) else m)))
+                    else:
+                        boss.open_url(m, program, cwd=cwd)
 
 
 if __name__ == '__main__':

kittens/hyperlinked_grep/main.py

@@ -20,15 +20,60 @@ def write_hyperlink(write: Callable[[bytes], None], url: bytes, line: bytes, fra
 
 
 def main() -> None:
-    if not sys.stdout.isatty() and '--pretty' not in sys.argv:
+    i = 1
+    all_link_options = {'matching_lines', 'context_lines', 'file_headers'}
+    link_options = set()
+    delegate_to_rg = False
+
+    def parse_link_options(raw: str) -> None:
+        nonlocal delegate_to_rg
+        if not raw:
+            raise SystemExit('Must specify an argument for --kitten option')
+        p, _, s = raw.partition('=')
+        if p != 'hyperlink':
+            raise SystemExit(f'Unknown argument for --kitten: {raw}')
+        for option in s.split(','):
+            if option == 'all':
+                link_options.update(all_link_options)
+                delegate_to_rg = False
+            elif option == 'none':
+                delegate_to_rg = True
+                link_options.clear()
+            elif option not in all_link_options:
+                a = ', '.join(sorted(all_link_options))
+                raise SystemExit(f"hyperlink option must be one of all, none, {a}, not '{option}'")
+            else:
+                link_options.add(option)
+                delegate_to_rg = False
+
+    while i < len(sys.argv):
+        if sys.argv[i] == '--kitten':
+            next_item = '' if i + 1 >= len(sys.argv) else sys.argv[i + 1]
+            parse_link_options(next_item)
+            del sys.argv[i:i+2]
+        elif sys.argv[i].startswith('--kitten='):
+            parse_link_options(sys.argv[i][len('--kitten='):])
+            del sys.argv[i]
+        else:
+            i += 1
+    if not link_options:  # Default to linking everything if no options given
+        link_options.update(all_link_options)
+    link_file_headers = 'file_headers' in link_options
+    link_context_lines = 'context_lines' in link_options
+    link_matching_lines = 'matching_lines' in link_options
+
+    if delegate_to_rg or (not sys.stdout.isatty() and '--pretty' not in sys.argv and '-p' not in sys.argv):
         os.execlp('rg', 'rg', *sys.argv[1:])
     cmdline = ['rg', '--pretty', '--with-filename'] + sys.argv[1:]
-    p = subprocess.Popen(cmdline, stdout=subprocess.PIPE)
+    try:
+        p = subprocess.Popen(cmdline, stdout=subprocess.PIPE)
+    except FileNotFoundError:
+        raise SystemExit('Could not find the rg executable in your PATH. Is ripgrep installed?')
     assert p.stdout is not None
     write: Callable[[bytes], None] = cast(Callable[[bytes], None], sys.stdout.buffer.write)
     sgr_pat = re.compile(br'\x1b\[.*?m')
     osc_pat = re.compile(b'\x1b\\].*?\x1b\\\\')
-    num_pat = re.compile(br'^(\d+)[:-]')
+    num_pat = re.compile(br'^(\d+)([:-])')
 
     in_result: bytes = b''
     hostname = socket.gethostname().encode('utf-8')
@@ -40,23 +85,25 @@ def main() -> None:
             if not clean_line:
                 in_result = b''
                 write(b'\n')
-                continue
+            elif in_result:
-            if in_result:
                 m = num_pat.match(clean_line)
                 if m is not None:
-                    write_hyperlink(write, in_result, line, frag=m.group(1))
+                    is_match_line = m.group(2) == b':'
-                else:
+                    if (is_match_line and link_matching_lines) or (not is_match_line and link_context_lines):
-                    write(line)
+                        write_hyperlink(write, in_result, line, frag=m.group(1))
+                        continue
+                write(line)
             else:
                 if line.strip():
                     path = quote_from_bytes(os.path.abspath(clean_line)).encode('utf-8')
                     in_result = b'file://' + hostname + path
-                    write_hyperlink(write, in_result, line)
+                    if link_file_headers:
-                else:
+                        write_hyperlink(write, in_result, line)
-                    write(line)
+                        continue
+                write(line)
     except KeyboardInterrupt:
         p.send_signal(signal.SIGINT)
-    except EOFError:
+    except (EOFError, BrokenPipeError):
         pass
     finally:
         p.stdout.close()

kittens/icat/main.py

@@ -42,24 +42,24 @@ Horizontal alignment for the displayed image.
 
 
 --place
-Choose where on the screen to display the image. The image will
+Choose where on the screen to display the image. The image will be scaled to fit
-be scaled to fit into the specified rectangle. The syntax for
+into the specified rectangle. The syntax for specifying rectangles is
-specifying rectangles is <:italic:`width`>x<:italic:`height`>@<:italic:`left`>x<:italic:`top`>.
+<:italic:`width`>x<:italic:`height`>@<:italic:`left`>x<:italic:`top`>.
-All measurements are in cells (i.e. cursor positions) with the
+All measurements are in cells (i.e. cursor positions) with the origin
-origin :italic:`(0, 0)` at the top-left corner of the screen.
+:italic:`(0, 0)` at the top-left corner of the screen.
 
 
 --scale-up
 type=bool-set
-When used in combination with :option:`--place` it will cause images that
+When used in combination with :option:`--place` it will cause images that are
-are smaller than the specified area to be scaled up to use as much
+smaller than the specified area to be scaled up to use as much of the specified
-of the specified area as possible.
+area as possible.
 
 
 --background
 default=none
-Specify a background color, this will cause transparent images to be composited on
+Specify a background color, this will cause transparent images to be composited
-top of the specified color.
+on top of the specified color.
 
 
 --mirror
@@ -79,17 +79,18 @@ type=choices
 choices=detect,file,stream
 default=detect
 Which mechanism to use to transfer images to the terminal. The default is to
-auto-detect. :italic:`file` means to use a temporary file and :italic:`stream` means to
+auto-detect. :italic:`file` means to use a temporary file and :italic:`stream`
-send the data via terminal escape codes. Note that if you use the :italic:`file`
+means to send the data via terminal escape codes. Note that if you use the
-transfer mode and you are connecting over a remote session then image display
+:italic:`file` transfer mode and you are connecting over a remote session then
-will not work.
+image display will not work.
 
 
 --detect-support
 type=bool-set
 Detect support for image display in the terminal. If not supported, will exit
 with exit code 1, otherwise will exit with code 0 and print the supported
-transfer mode to stderr, which can be used with the :option:`--transfer-mode` option.
+transfer mode to stderr, which can be used with the :option:`--transfer-mode`
+option.
 
 
 --detection-timeout
@@ -101,17 +102,17 @@ detecting image display support.
 
 --print-window-size
 type=bool-set
-Print out the window size as :italic:`widthxheight` (in pixels) and quit. This is a
+Print out the window size as <:italic:`width`>x<:italic:`height`> (in pixels) and quit. This is a
-convenience method to query the window size if using :code:`kitty +kitten icat` from a
+convenience method to query the window size if using :code:`kitty +kitten icat`
-scripting language that cannot make termios calls.
+from a scripting language that cannot make termios calls.
 
 
 --stdin
 type=choices
 choices=detect,yes,no
 default=detect
-Read image data from stdin. The default is to do it automatically, when STDIN is not a terminal,
+Read image data from STDIN. The default is to do it automatically, when STDIN is
-but you can turn it off or on explicitly, if needed.
+not a terminal, but you can turn it off or on explicitly, if needed.
 
 
 --silent
@@ -121,9 +122,9 @@ Do not print out anything to STDOUT during operation.
 
 --z-index -z
 default=0
-Z-index of the image. When negative, text will be displayed on top of the image. Use
+Z-index of the image. When negative, text will be displayed on top of the image.
-a double minus for values under the threshold for drawing images under cell background
+Use a double minus for values under the threshold for drawing images under cell
-colors. For example, :code:`--1` evaluates as -1,073,741,825.
+background colors. For example, :code:`--1` evaluates as -1,073,741,825.
 
 
 --loop -l
@@ -352,7 +353,7 @@ def process(path: str, args: IcatCLIOptions, parsed_opts: ParsedOpts, is_tempfil
         else:
             import struct
             use_number = max(1, struct.unpack('@I', os.urandom(4))[0])
-            with NamedTemporaryFile() as f:
+            with NamedTemporaryFile(prefix='tty-graphics-protocol-') as f:
                 prefix = f.name
             frame_data = render_image(
                 path, prefix, m, available_width, available_height, args.scale_up,
@@ -404,7 +405,7 @@ def detect_support(wait_for: float = 10, silent: bool = False) -> bool:
             parse_responses()
             return 1 not in responses or 2 not in responses
 
-        with NamedTemporaryFile() as f:
+        with NamedTemporaryFile(prefix='tty-graphics-protocol') as f:
             f.write(b'abcd')
             f.flush()
             gc = GraphicsCommand()
@@ -471,13 +472,13 @@ def process_single_item(
     file_removed = False
     try:
         if isinstance(item, bytes):
-            with NamedTemporaryFile(prefix='stdin-image-data-', delete=False) as tf:
+            with NamedTemporaryFile(prefix='tty-graphics-protocol-', delete=False) as tf:
                 tf.write(item)
             item = tf.name
             is_tempfile = True
         if url_pat is not None and url_pat.match(item) is not None:
             from urllib.request import urlretrieve
-            with NamedTemporaryFile(prefix='url-image-data-', delete=False) as tf:
+            with NamedTemporaryFile(prefix='tty-graphics-protocol-', delete=False) as tf:
                 try:
                     with socket_timeout(30):
                         urlretrieve(item, filename=tf.name)
@@ -515,7 +516,12 @@ def main(args: List[str] = sys.argv) -> None:
     if cli_opts.print_window_size:
         screen_size_function.cache_clear()
         with open(os.ctermid()) as tty:
-            ss = screen_size_function(tty)()
+            try:
+                fd = tty.fileno()
+            except AttributeError:
+                # use default value for fd if ctermid is not available
+                fd = None
+            ss = screen_size_function(fd)()
         print(f'{ss.width}x{ss.height}', end='')
         raise SystemExit(0)
 

kittens/query_terminal/main.py

@@ -66,7 +66,7 @@ def query(cls: Type[Query]) -> Type[Query]:
 class TerminalName(Query):
     name: str = 'name'
     override_query_name: str = 'name'
-    help_text: str = f'Terminal name ({names[0]})'
+    help_text: str = f'Terminal name (e.g. :code:`{names[0]}`)'
 
     @staticmethod
     def get_result(opts: Options) -> str:
@@ -76,7 +76,7 @@ class TerminalName(Query):
 @query
 class TerminalVersion(Query):
     name: str = 'version'
-    help_text: str = 'Terminal version, for e.g.: 0.19.2'
+    help_text: str = f'Terminal version (e.g. :code:`{str_version}`)'
 
     @staticmethod
     def get_result(opts: Options) -> str:
@@ -86,7 +86,7 @@ class TerminalVersion(Query):
 @query
 class AllowHyperlinks(Query):
     name: str = 'allow_hyperlinks'
-    help_text: str = 'The :opt:`setting <allow_hyperlinks>` for allowing hyperlinks can be yes, no or ask'
+    help_text: str = 'The config option :opt:`allow_hyperlinks` in :file:`kitty.conf` for allowing hyperlinks can be :code:`yes`, :code:`no` or :code:`ask`'
 
     @staticmethod
     def get_result(opts: Options) -> str:
@@ -154,7 +154,7 @@ class FontSize(Query):
 @query
 class ClipboardControl(Query):
     name: str = 'clipboard_control'
-    help_text: str = 'The :opt:`setting <clipboard_control>` for allowing reads/writes to/from the clipboard'
+    help_text: str = 'The config option :opt:`clipboard_control` in :file:`kitty.conf` for allowing reads/writes to/from the clipboard'
 
     @staticmethod
     def get_result(opts: Options) -> str:
@@ -173,17 +173,22 @@ def do_queries(queries: Iterable[str], cli_opts: QueryTerminalCLIOptions) -> Dic
     actions = tuple(all_queries[x]() for x in queries)
     qstring = ''.join(a.query_code() for a in actions)
     received = b''
+    pat = re.compile(rb'\x1b\[\?.+?c')
 
     def more_needed(data: bytes) -> bool:
         nonlocal received
         received += data
+        has_da1_response = pat.search(received) is not None
+        if has_da1_response:
+            return False
         for a in actions:
             if a.more_needed(received):
                 return True
-        return False
+        return has_da1_response
 
     with TTYIO() as ttyio:
         ttyio.send(qstring)
+        ttyio.send('\x1b[c')  # DA1 query https://vt100.net/docs/vt510-rm/DA1.html
         ttyio.recv(more_needed, timeout=cli_opts.wait_for)
 
     return {a.name: a.output_line() for a in actions}
@@ -200,30 +205,28 @@ querying it.
 
 
 help_text = '''\
-Query the terminal this kitten is run in for various
+Query the terminal this kitten is run in for various capabilities. This sends
-capabilities. This sends escape codes to the terminal
+escape codes to the terminal and based on its response prints out data about
-and based on its response prints out data about supported
+supported capabilities. Note that this is a blocking operation, since it has to
-capabilities. Note that this is a blocking operation, since
+wait for a response from the terminal. You can control the maximum wait time via
-it has to wait for a response from the terminal. You can control
+the :code:`--wait-for` option.
-the maximum wait time via the ``--wait-for`` option.
 
 The output is lines of the form::
 
-  query: data
+    query: data
 
-If a particular query is unsupported by the running kitty version,
+If a particular :italic:`query` is unsupported by the running kitty version, the
-the data will be blank.
+:italic:`data` will be blank.
 
-Note that when calling this from another program, be very
+Note that when calling this from another program, be very careful not to perform
-careful not to perform any I/O on the terminal device
+any I/O on the terminal device until this kitten exits.
-until the kitten exits.
 
 Available queries are:
 
 {}
 
 '''.format('\n'.join(
-    f'``{name}``\n  {c.help_text}\n' for name, c in all_queries.items()))
+    f':code:`{name}`:\n  {c.help_text}\n' for name, c in all_queries.items()))
 usage = '[query1 query2 ...]'
 
 

kittens/remote_file/main.py

@@ -27,6 +27,9 @@ from ..tui.operations import (
 from ..tui.utils import get_key_press
 
 
+is_ssh_kitten_sentinel = '!#*&$#($ssh-kitten)(##$'
+
+
 def key(x: str) -> str:
     return styled(x, bold=True, fg='green')
 
@@ -53,10 +56,9 @@ The data used to connect over ssh.
 
 
 def show_error(msg: str) -> None:
-    print(styled(msg, fg='red'))
+    print(styled(msg, fg='red'), file=sys.stderr)
     print()
-    print('Press any key to exit...')
+    print('Press any key to quit', flush=True)
-    sys.stdout.flush()
     with raw_mode():
         while True:
             try:
@@ -112,15 +114,25 @@ class ControlMaster:
         self.remote_path = remote_path
         self.dest = dest
         self.tdir = ''
+        self.last_error_log = ''
         self.cmd_prefix = cmd = [
             conn_data.binary, '-o', f'ControlPath=~/.ssh/kitty-master-{os.getpid()}-%r@%h:%p',
             '-o', 'TCPKeepAlive=yes', '-o', 'ControlPersist=yes'
         ]
-        if conn_data.port:
+        self.is_ssh_kitten = conn_data.binary is is_ssh_kitten_sentinel
-            cmd.extend(['-p', str(conn_data.port)])
+        if self.is_ssh_kitten:
-        if conn_data.identity_file:
+            del cmd[:]
-            cmd.extend(['-i', conn_data.identity_file])
+            self.batch_cmd_prefix = cmd
-        self.batch_cmd_prefix = cmd + ['-o', 'BatchMode=yes']
+            sk_cmdline = json.loads(conn_data.identity_file)
+            while '-t' in sk_cmdline:
+                sk_cmdline.remove('-t')
+            cmd.extend(sk_cmdline[:-2])
+        else:
+            if conn_data.port:
+                cmd.extend(['-p', str(conn_data.port)])
+            if conn_data.identity_file:
+                cmd.extend(['-i', conn_data.identity_file])
+            self.batch_cmd_prefix = cmd + ['-o', 'BatchMode=yes']
 
     def check_call(self, cmd: List[str]) -> None:
         p = subprocess.Popen(cmd, stdout=subprocess.PIPE, stderr=subprocess.STDOUT, stdin=subprocess.DEVNULL)
@@ -130,31 +142,37 @@ class ControlMaster:
             raise Exception(f'The ssh command: {shlex.join(cmd)} failed with exit code {p.returncode} and output: {out}')
 
     def __enter__(self) -> 'ControlMaster':
-        self.check_call(
+        if not self.is_ssh_kitten:
-            self.cmd_prefix + ['-o', 'ControlMaster=auto', '-fN', self.conn_data.hostname])
+            self.check_call(
-        self.check_call(
+                self.cmd_prefix + ['-o', 'ControlMaster=auto', '-fN', self.conn_data.hostname])
-            self.batch_cmd_prefix + ['-O', 'check', self.conn_data.hostname])
+            self.check_call(
+                self.batch_cmd_prefix + ['-O', 'check', self.conn_data.hostname])
         if not self.dest:
             self.tdir = tempfile.mkdtemp()
             self.dest = os.path.join(self.tdir, os.path.basename(self.remote_path))
         return self
 
     def __exit__(self, *a: Any) -> None:
-        subprocess.Popen(
+        if not self.is_ssh_kitten:
-            self.batch_cmd_prefix + ['-O', 'exit', self.conn_data.hostname],
+            subprocess.Popen(
-            stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL, stdin=subprocess.DEVNULL
+                self.batch_cmd_prefix + ['-O', 'exit', self.conn_data.hostname],
-        ).wait()
+                stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL, stdin=subprocess.DEVNULL
+            ).wait()
         if self.tdir:
             shutil.rmtree(self.tdir)
 
     @property
     def is_alive(self) -> bool:
+        if self.is_ssh_kitten:
+            return True
         return subprocess.Popen(
             self.batch_cmd_prefix + ['-O', 'check', self.conn_data.hostname],
             stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL, stdin=subprocess.DEVNULL
         ).wait() == 0
 
     def check_hostname_matches(self) -> bool:
+        if self.is_ssh_kitten:
+            return True
         cp = subprocess.run(self.batch_cmd_prefix + [self.conn_data.hostname, 'hostname', '-f'], stdout=subprocess.PIPE,
                             stderr=subprocess.DEVNULL, stdin=subprocess.DEVNULL)
         if cp.returncode == 0:
@@ -181,21 +199,35 @@ class ControlMaster:
                 return response == 'y'
         return True
 
+    def show_error(self, msg: str) -> None:
+        if self.last_error_log:
+            print(self.last_error_log, file=sys.stderr)
+            self.last_error_log = ''
+        show_error(msg)
+
     def download(self) -> bool:
+        cmdline = self.batch_cmd_prefix + [self.conn_data.hostname, 'cat', shlex.quote(self.remote_path)]
         with open(self.dest, 'wb') as f:
-            return subprocess.run(
+            cp = subprocess.run(cmdline, stdout=f, stderr=subprocess.PIPE, stdin=subprocess.DEVNULL)
-                self.batch_cmd_prefix + [self.conn_data.hostname, 'cat', self.remote_path],
+            if cp.returncode != 0:
-                stdout=f, stderr=subprocess.DEVNULL, stdin=subprocess.DEVNULL
+                self.last_error_log = f'The command: {shlex.join(cmdline)} failed\n' + cp.stderr.decode()
-            ).returncode == 0
+                return False
+        return True
 
     def upload(self, suppress_output: bool = True) -> bool:
         cmd_prefix = self.cmd_prefix if suppress_output else self.batch_cmd_prefix
-        cmd = cmd_prefix + [self.conn_data.hostname, 'cat', '>', self.remote_path]
+        cmd = cmd_prefix + [self.conn_data.hostname, 'cat', '>', shlex.quote(self.remote_path)]
         if not suppress_output:
-            print(' '.join(map(shlex.quote, cmd)))
+            print(shlex.join(cmd))
-        redirect = subprocess.DEVNULL if suppress_output else None
         with open(self.dest, 'rb') as f:
-            return subprocess.run(cmd, stdout=redirect, stderr=redirect, stdin=f).returncode == 0
+            if suppress_output:
+                cp = subprocess.run(cmd, stdin=f, capture_output=True)
+                if cp.returncode == 0:
+                    return True
+                self.last_error_log = f'The command: {shlex.join(cmd)} failed\n' + cp.stdout.decode()
+            else:
+                return subprocess.run(cmd, stdin=f).returncode == 0
+        return False
 
 
 Result = Optional[str]
@@ -208,7 +240,7 @@ def main(args: List[str]) -> Result:
     except SystemExit as e:
         if e.code != 0:
             print(e.args[0])
-            input('Press enter to quit...')
+            input('Press Enter to quit')
         raise SystemExit(e.code)
 
     try:
@@ -236,14 +268,14 @@ def save_as(conn_data: SSHConnectionData, remote_path: str, cli_opts: RemoteFile
         last_used_path = tempfile.gettempdir()
     last_used_file = os.path.join(last_used_path, os.path.basename(remote_path))
     print(
-        'Where do you wish to save the file? Leaving it blank will save it as:',
+        'Where do you want to save the file? Leaving it blank will save it as:',
         styled(last_used_file, fg='yellow')
     )
     print('Relative paths will be resolved from:', styled(os.getcwd(), fg_intense=True, bold=True))
     print()
-    from ..tui.path_completer import PathCompleter
+    from ..tui.path_completer import get_path
     try:
-        dest = PathCompleter().input()
+        dest = get_path()
     except (KeyboardInterrupt, EOFError):
         return
     if dest:
@@ -278,11 +310,15 @@ def save_as(conn_data: SSHConnectionData, remote_path: str, cli_opts: RemoteFile
     with ControlMaster(conn_data, remote_path, cli_opts, dest=dest) as master:
         if master.check_hostname_matches():
             if not master.download():
-                show_error('Failed to copy file from remote machine')
+                master.show_error('Failed to copy file from remote machine')
 
 
 def handle_action(action: str, cli_opts: RemoteFileCLIOptions) -> Result:
-    conn_data = SSHConnectionData(*json.loads(cli_opts.ssh_connection_data or ''))
+    cli_data = json.loads(cli_opts.ssh_connection_data or '')
+    if cli_data and cli_data[0] == is_ssh_kitten_sentinel:
+        conn_data = SSHConnectionData(is_ssh_kitten_sentinel, cli_data[-1], -1, identity_file=json.dumps(cli_data[1:]))
+    else:
+        conn_data = SSHConnectionData(*cli_data)
     remote_path = cli_opts.path or ''
     if action == 'open':
         print('Opening', cli_opts.path, 'from', cli_opts.hostname)
@@ -291,7 +327,7 @@ def handle_action(action: str, cli_opts: RemoteFileCLIOptions) -> Result:
             if master.check_hostname_matches():
                 if master.download():
                     return dest
-                show_error('Failed to copy file from remote machine')
+                master.show_error('Failed to copy file from remote machine')
     elif action == 'edit':
         print('Editing', cli_opts.path, 'from', cli_opts.hostname)
         editor = get_editor()
@@ -299,7 +335,7 @@ def handle_action(action: str, cli_opts: RemoteFileCLIOptions) -> Result:
             if not master.check_hostname_matches():
                 return None
             if not master.download():
-                show_error(f'Failed to download {remote_path}')
+                master.show_error(f'Failed to download {remote_path}')
                 return None
             mtime = os.path.getmtime(master.dest)
             print(reset_terminal(), end='', flush=True)
@@ -314,9 +350,9 @@ def handle_action(action: str, cli_opts: RemoteFileCLIOptions) -> Result:
             print(reset_terminal(), end='', flush=True)
             if master.is_alive:
                 if not master.upload(suppress_output=False):
-                    show_error(f'Failed to upload {remote_path}')
+                    master.show_error(f'Failed to upload {remote_path}')
             else:
-                show_error(f'Failed to upload {remote_path}, SSH master process died')
+                master.show_error(f'Failed to upload {remote_path}, SSH master process died')
     elif action == 'save':
         print('Saving', cli_opts.path, 'from', cli_opts.hostname)
         save_as(conn_data, remote_path, cli_opts)

kittens/runner.py

@@ -69,6 +69,7 @@ def create_kitten_handler(kitten: str, orig_args: List[str]) -> Any:
     ans = partial(m['end'], [kitten] + orig_args)
     setattr(ans, 'type_of_input', getattr(m['end'], 'type_of_input', None))
     setattr(ans, 'no_ui', getattr(m['end'], 'no_ui', False))
+    setattr(ans, 'has_ready_notification', getattr(m['end'], 'has_ready_notification', False))
     return ans
 
 
@@ -85,32 +86,23 @@ def launch(args: List[str]) -> None:
     del args[:2]
     args = [kitten] + args
     os.environ['KITTY_CONFIG_DIRECTORY'] = config_dir
-    from kittens.tui.operations import Mode, clear_screen, reset_mode
     set_debug(kitten)
     m = import_kitten_main_module(config_dir, kitten)
     try:
         result = m['start'](args)
     finally:
         sys.stdin = sys.__stdin__
-    print(reset_mode(Mode.ALTERNATE_SCREEN) + clear_screen(), end='')
     if result is not None:
         import json
-        data = json.dumps(result)
+        import base64
-        print('OK:', len(data), data)
+        data = base64.b85encode(json.dumps(result).encode('utf-8'))
+        sys.stdout.buffer.write(b'\x1bP@kitty-kitten-result|')
+        sys.stdout.buffer.write(data)
+        sys.stdout.buffer.write(b'\x1b\\')
     sys.stderr.flush()
     sys.stdout.flush()
 
 
-def deserialize(output: str) -> Any:
-    import json
-    if output.startswith('OK: '):
-        try:
-            prefix, sz, rest = output.split(' ', 2)
-            return json.loads(rest[:int(sz)])
-        except Exception:
-            raise ValueError(f'Failed to parse kitten output: {output!r}')
-
-
 def run_kitten(kitten: str, run_name: str = '__main__') -> None:
     import runpy
     original_kitten_name = kitten
@@ -130,7 +122,11 @@ def run_kitten(kitten: str, run_name: str = '__main__') -> None:
             print(kitten, file=sys.stderr)
         raise SystemExit(f'No kitten named {original_kitten_name}')
     m = runpy.run_path(path, init_globals={'sys': sys, 'os': os}, run_name='__run_kitten__')
-    m['main'](sys.argv)
+    from kitty.fast_data_types import set_options
+    try:
+        m['main'](sys.argv)
+    finally:
+        set_options(None)
 
 
 @run_once
@@ -183,4 +179,4 @@ def main() -> None:
         print('Unhandled exception running kitten:')
         import traceback
         traceback.print_exc()
-        input('Press Enter to quit...')
+        input('Press Enter to quit')

kittens/show_error/main.py

@@ -1,13 +1,17 @@
 #!/usr/bin/env python3
 # License: GPL v3 Copyright: 2018, Kovid Goyal <kovid at kovidgoyal.net>
 
+import json
 import os
 import sys
+import termios
 from contextlib import suppress
 from typing import List
 
 from kitty.cli import parse_args
 from kitty.cli_stub import ErrorCLIOptions
+from kitty.fast_data_types import open_tty
+from kitty.utils import hold_till_enter, no_echo, write_all
 
 from ..tui.operations import styled
 
@@ -21,14 +25,35 @@ The title for the error message.
 def real_main(args: List[str]) -> None:
     msg = 'Show an error message'
     cli_opts, items = parse_args(args[1:], OPTIONS, '', msg, 'hints', result_class=ErrorCLIOptions)
-    error_message = sys.stdin.buffer.read().decode('utf-8')
+    data = json.loads(sys.stdin.buffer.read())
-    sys.stdin = open(os.ctermid())
+    error_message = data['msg']
     if cli_opts.title:
         print(styled(cli_opts.title, fg_intense=True, fg='red', bold=True))
         print()
-    print(error_message)
+    print(error_message, flush=True)
-    print()
+    if data.get('tb'):
-    input('\x1b[1;32mPress Enter to close\x1b[m')
+        import select
+        from kittens.tui.operations import init_state, set_cursor_visible
+        fd, original_termios = open_tty()
+        msg = '\n\r\x1b[1;32mPress e to see detailed traceback or any other key to exit\x1b[m'
+        write_all(fd, msg)
+        write_all(fd, init_state(alternate_screen=False, kitty_keyboard_mode=False) + set_cursor_visible(False))
+        with no_echo(fd):
+            termios.tcdrain(fd)
+            while True:
+                rd = select.select([fd], [], [])[0]
+                if not rd:
+                    break
+                q = os.read(fd, 1)
+                if q in b'eE':
+                    break
+                return
+    if data.get('tb'):
+        tb = data['tb']
+        for ln in tb.splitlines():
+            print('\r\n', ln, sep='', end='')
+        print(flush=True)
+    hold_till_enter()
 
 
 def main(args: List[str]) -> None:
@@ -38,7 +63,7 @@ def main(args: List[str]) -> None:
     except Exception:
         import traceback
         traceback.print_exc()
-        input('Press Enter to close.')
+        input('Press Enter to close')
 
 
 if __name__ == '__main__':

kittens/show_key/kitty_mode.py

@@ -34,7 +34,7 @@ def format_mods(mods: int) -> str:
 class KeysHandler(Handler):
 
     def initialize(self) -> None:
-        self.cmd.set_window_title('Kitty extended keyboard protocol demo')
+        self.cmd.set_window_title('kitty extended keyboard protocol demo')
         self.cmd.set_cursor_visible(False)
         self.print('Press any keys - Ctrl+C or Ctrl+D will terminate')
 
@@ -47,7 +47,10 @@ class KeysHandler(Handler):
         mods = format_mods(key_event.mods)
         if mods:
             mods += '+'
-        key = f'{mods}{key_event.key} '
+        kk = key_event.key
+        if kk == ' ':
+            kk = 'SPACE'
+        key = f'{mods}{kk} '
         self.cmd.colored(key, 'green')
         self.cmd.colored(etype + ' ', 'yellow')
         self.cmd.styled(key_event.text, italic=True)

kittens/show_key/main.py

@@ -24,7 +24,7 @@ def print_key(raw: bytearray) -> None:
             unix += chr(ch)
     print(unix + '\t\t', end='')
     for ch in raw:
-        x = chr(ch).encode('ascii')
+        x = chr(ch).encode('utf-8')
         print(styled(repr(x)[2:-1], fg='yellow'), end='')
     print(end='\r\n', flush=True)
 
@@ -45,7 +45,7 @@ def read_keys() -> None:
 
 
 def legacy_main() -> None:
-    print('Press any keys - Ctrl-D will terminate this program', end='\r\n', flush=True)
+    print('Press any keys - Ctrl+D will terminate this program', end='\r\n', flush=True)
     print(styled('UNIX', italic=True, fg='green'), styled('send_text', italic=True, fg='green'), sep='\t\t', end='\r\n')
 
     with raw_mode():
@@ -57,13 +57,16 @@ OPTIONS = r'''
 default=normal
 type=choices
 choices=normal,application,kitty,unchanged
-The keyboard mode to use when showing keys. "normal" mode is with DECCKM reset and "application" mode is with
+The keyboard mode to use when showing keys. :code:`normal` mode is with DECCKM
-DECCKM set. "kitty" is the full kitty extended keyboard protocol.
+reset and :code:`application` mode is with DECCKM set. :code:`kitty` is the full
+kitty extended keyboard protocol.
 '''.format
+help_text = 'Show the codes generated by the terminal for key presses in various keyboard modes'
+usage = ''
 
 
 def main(args: List[str]) -> None:
-    cli_opts, items = parse_args(args[1:], OPTIONS, '', '', 'kitty +kitten show_key', result_class=ShowKeyCLIOptions)
+    cli_opts, items = parse_args(args[1:], OPTIONS, '', help_text, 'kitty +kitten show_key', result_class=ShowKeyCLIOptions)
     if cli_opts.key_mode == 'kitty':
         from .kitty_mode import main as kitty_main
         return kitty_main()
@@ -78,3 +81,8 @@ def main(args: List[str]) -> None:
 
 if __name__ == '__main__':
     main(sys.argv)
+elif __name__ == '__doc__':
+    cd = sys.cli_docs  # type: ignore
+    cd['usage'] = usage
+    cd['options'] = OPTIONS
+    cd['help_text'] = help_text

kittens/ssh/completion.py

@@ -8,6 +8,7 @@ from typing import Callable, Dict, Iterable, Iterator, Sequence, Tuple
 
 from kitty.complete import Completions, complete_files_and_dirs, debug
 from kitty.types import run_once
+from .utils import ssh_options
 
 debug
 
@@ -71,47 +72,6 @@ def known_hosts() -> Tuple[str, ...]:
     return tuple(sorted(filter(lambda x: '*' not in x and '[' not in x, set(iter_known_hosts()))))
 
 
-@run_once
-def ssh_options() -> Dict[str, str]:
-    try:
-        p = subprocess.run(['ssh'], stderr=subprocess.PIPE, encoding='utf-8')
-        raw = p.stderr or ''
-    except FileNotFoundError:
-        return {
-            '4': '', '6': '', 'A': '', 'a': '', 'C': '', 'f': '', 'G': '', 'g': '', 'K': '', 'k': '',
-            'M': '', 'N': '', 'n': '', 'q': '', 's': '', 'T': '', 't': '', 'V': '', 'v': '', 'X': '',
-            'x': '', 'Y': '', 'y': '', 'B': 'bind_interface', 'b': 'bind_address', 'c': 'cipher_spec',
-            'D': '[bind_address:]port', 'E': 'log_file', 'e': 'escape_char', 'F': 'configfile', 'I': 'pkcs11',
-            'i': 'identity_file', 'J': '[user@]host[:port]', 'L': 'address', 'l': 'login_name', 'm': 'mac_spec',
-            'O': 'ctl_cmd', 'o': 'option', 'p': 'port', 'Q': 'query_option', 'R': 'address',
-            'S': 'ctl_path', 'W': 'host:port', 'w': 'local_tun[:remote_tun]'
-        }
-
-    ans: Dict[str, str] = {}
-    pos = 0
-    while True:
-        pos = raw.find('[', pos)
-        if pos < 0:
-            break
-        num = 1
-        epos = pos
-        while num > 0:
-            epos += 1
-            if raw[epos] not in '[]':
-                continue
-            num += 1 if raw[epos] == '[' else -1
-        q = raw[pos+1:epos]
-        pos = epos
-        if len(q) < 2 or q[0] != '-':
-            continue
-        if ' ' in q:
-            opt, desc = q.split(' ', 1)
-            ans[opt[1:]] = desc
-        else:
-            ans.update(dict.fromkeys(q[1:], ''))
-    return ans
-
-
 # option help {{{
 @run_once
 def option_help_map() -> Dict[str, str]:
@@ -331,6 +291,7 @@ def complete_option(ans: Completions, prefix: str = '-') -> None:
 def complete(ans: Completions, words: Sequence[str], new_word: bool) -> None:
     options = ssh_options()
     expecting_arg = False
+    seen_destination = False
     types = ['' for i in range(len(words))]
     for i, word in enumerate(words):
         if expecting_arg:
@@ -342,8 +303,10 @@ def complete(ans: Completions, words: Sequence[str], new_word: bool) -> None:
             if len(word) == 2 and options.get(word[1]):
                 expecting_arg = True
             continue
+        if seen_destination:
+            break
         types[i] = 'destination'
-        break
+        seen_destination = True
     if new_word:
         if words:
             if expecting_arg:

kittens/ssh/config.py

@@ -0,0 +1,74 @@
+#!/usr/bin/env python
+# License: GPLv3 Copyright: 2022, Kovid Goyal <kovid at kovidgoyal.net>
+
+
+import fnmatch
+import os
+from typing import Any, Dict, Iterable, Optional
+
+from kitty.conf.utils import (
+    load_config as _load_config, parse_config_base, resolve_config
+)
+from kitty.constants import config_dir
+
+from .options.types import Options as SSHOptions, defaults
+
+SYSTEM_CONF = '/etc/xdg/kitty/ssh.conf'
+defconf = os.path.join(config_dir, 'ssh.conf')
+
+
+def host_matches(mpat: str, hostname: str, username: str) -> bool:
+    for pat in mpat.split():
+        upat = '*'
+        if '@' in pat:
+            upat, pat = pat.split('@', 1)
+        if fnmatch.fnmatchcase(hostname, pat) and fnmatch.fnmatchcase(username, upat):
+            return True
+    return False
+
+
+def load_config(*paths: str, overrides: Optional[Iterable[str]] = None, hostname: str = '!', username: str = '') -> SSHOptions:
+    from .options.parse import (
+        create_result_dict, merge_result_dicts, parse_conf_item
+    )
+    from .options.utils import (
+        first_seen_positions, get_per_hosts_dict, init_results_dict
+    )
+
+    def merge_dicts(base: Dict[str, Any], vals: Dict[str, Any]) -> Dict[str, Any]:
+        base_phd = get_per_hosts_dict(base)
+        vals_phd = get_per_hosts_dict(vals)
+        for hostname in base_phd:
+            vals_phd[hostname] = merge_result_dicts(base_phd[hostname], vals_phd.get(hostname, {}))
+        ans: Dict[str, Any] = vals_phd.pop(vals['hostname'])
+        ans['per_host_dicts'] = vals_phd
+        return ans
+
+    def parse_config(lines: Iterable[str]) -> Dict[str, Any]:
+        ans: Dict[str, Any] = init_results_dict(create_result_dict())
+        parse_config_base(lines, parse_conf_item, ans)
+        return ans
+
+    overrides = tuple(overrides) if overrides is not None else ()
+    first_seen_positions.clear()
+    first_seen_positions['*'] = 0
+    opts_dict, paths = _load_config(
+        defaults, parse_config, merge_dicts, *paths, overrides=overrides, initialize_defaults=init_results_dict)
+    phd = get_per_hosts_dict(opts_dict)
+    final_dict: Dict[str, Any] = {}
+    for hostname_pat in sorted(phd, key=first_seen_positions.__getitem__):
+        if host_matches(hostname_pat, hostname, username):
+            od = phd[hostname_pat]
+            for k, v in od.items():
+                if isinstance(v, dict):
+                    bv = final_dict.setdefault(k, {})
+                    bv.update(v)
+                else:
+                    final_dict[k] = v
+    first_seen_positions.clear()
+    return SSHOptions(final_dict)
+
+
+def init_config(hostname: str, username: str, overrides: Optional[Iterable[str]] = None) -> SSHOptions:
+    config = tuple(resolve_config(SYSTEM_CONF, defconf))
+    return load_config(*config, overrides=overrides, hostname=hostname, username=username)

kittens/ssh/copy.py

@@ -0,0 +1,119 @@
+#!/usr/bin/env python
+# License: GPLv3 Copyright: 2022, Kovid Goyal <kovid at kovidgoyal.net>
+
+
+import glob
+import os
+import shlex
+import uuid
+from typing import (
+    Dict, Iterable, Iterator, List, NamedTuple, Optional, Sequence, Tuple
+)
+
+from kitty.cli import parse_args
+from kitty.cli_stub import CopyCLIOptions
+from kitty.types import run_once
+
+from ..transfer.utils import expand_home, home_path
+
+
+@run_once
+def option_text() -> str:
+    return '''
+--glob
+type=bool-set
+Interpret file arguments as glob patterns.
+
+
+--dest
+The destination on the remote host to copy to. Relative paths are resolved
+relative to HOME on the remote host. When this option is not specified, the
+local file path is used as the remote destination (with the HOME directory
+getting automatically replaced by the remote HOME). Note that environment
+variables and ~ are not expanded.
+
+
+--exclude
+type=list
+A glob pattern. Files with names matching this pattern are excluded from being
+transferred. Useful when adding directories. Can
+be specified multiple times, if any of the patterns match the file will be
+excluded. To exclude a directory use a pattern like */directory_name/*.
+
+
+--symlink-strategy
+default=preserve
+choices=preserve,resolve,keep-path
+Control what happens if the specified path is a symlink. The default is to preserve
+the symlink, re-creating it on the remote machine. Setting this to :code:`resolve`
+will cause the symlink to be followed and its target used as the file/directory to copy.
+The value of :code:`keep-path` is the same as :code:`resolve` except that the remote
+file path is derived from the symlink's path instead of the path of the symlink's target.
+Note that this option does not apply to symlinks encountered while recursively copying directories.
+'''
+
+
+def parse_copy_args(args: Optional[Sequence[str]] = None) -> Tuple[CopyCLIOptions, List[str]]:
+    args = list(args or ())
+    try:
+        opts, args = parse_args(result_class=CopyCLIOptions, args=args, ospec=option_text)
+    except SystemExit as e:
+        raise CopyCLIError from e
+    return opts, args
+
+
+def resolve_file_spec(spec: str, is_glob: bool) -> Iterator[str]:
+    ans = os.path.expandvars(expand_home(spec))
+    if not os.path.isabs(ans):
+        ans = expand_home(f'~/{ans}')
+    if is_glob:
+        files = glob.glob(ans)
+        if not files:
+            raise CopyCLIError(f'{spec} does not exist')
+    else:
+        if not os.path.exists(ans):
+            raise CopyCLIError(f'{spec} does not exist')
+        files = [ans]
+    for x in files:
+        yield os.path.normpath(x).replace(os.sep, '/')
+
+
+class CopyCLIError(ValueError):
+    pass
+
+
+def get_arcname(loc: str, dest: Optional[str], home: str) -> str:
+    if dest:
+        arcname = dest
+    else:
+        arcname = os.path.normpath(loc)
+        if arcname.startswith(home):
+            arcname = os.path.relpath(arcname, home)
+    arcname = os.path.normpath(arcname).replace(os.sep, '/')
+    prefix = 'root' if arcname.startswith('/') else 'home/'
+    return prefix + arcname
+
+
+class CopyInstruction(NamedTuple):
+    local_path: str
+    arcname: str
+    exclude_patterns: Tuple[str, ...]
+
+
+def parse_copy_instructions(val: str, current_val: Dict[str, str]) -> Iterable[Tuple[str, CopyInstruction]]:
+    opts, args = parse_copy_args(shlex.split(val))
+    locations: List[str] = []
+    for a in args:
+        locations.extend(resolve_file_spec(a, opts.glob))
+    if not locations:
+        raise CopyCLIError('No files to copy specified')
+    if len(locations) > 1 and opts.dest:
+        raise CopyCLIError('Specifying a remote location with more than one file is not supported')
+    home = home_path()
+    for loc in locations:
+        if opts.symlink_strategy != 'preserve':
+            rp = os.path.realpath(loc)
+        else:
+            rp = loc
+        arcname = get_arcname(rp if opts.symlink_strategy == 'resolve' else loc, opts.dest, home)
+        yield str(uuid.uuid4()), CopyInstruction(rp, arcname, tuple(opts.exclude))

kittens/ssh/main.py

@@ -1,139 +1,303 @@
 #!/usr/bin/env python3
 # License: GPL v3 Copyright: 2018, Kovid Goyal <kovid at kovidgoyal.net>
 
+import fnmatch
+import glob
+import io
+import json
 import os
+import re
+import secrets
 import shlex
+import shutil
+import stat
 import subprocess
 import sys
-from contextlib import suppress
+import tarfile
-from typing import List, NoReturn, Optional, Set, Tuple
+import tempfile
-from .completion import ssh_options, complete
+import termios
+import time
+import traceback
+from base64 import standard_b64decode, standard_b64encode
+from contextlib import contextmanager, suppress
+from getpass import getuser
+from select import select
+from typing import (
+    Any, Callable, Dict, Iterator, List, NoReturn, Optional, Sequence, Set,
+    Tuple, Union, cast
+)
 
-from kitty.utils import SSHConnectionData
+from kitty.constants import (
+    cache_dir, runtime_dir, shell_integration_dir, ssh_control_master_template,
+    str_version, terminfo_dir
+)
+from kitty.shell_integration import as_str_literal
+from kitty.shm import SharedMemory
+from kitty.types import run_once
+from kitty.utils import (
+    SSHConnectionData, expandvars, resolve_abs_or_config_path,
+    set_echo as turn_off_echo
+)
 
-SHELL_SCRIPT = '''\
+from ..tui.operations import (
-#!/bin/sh
+    RESTORE_PRIVATE_MODE_VALUES, SAVE_PRIVATE_MODE_VALUES, Mode,
-# macOS ships with an ancient version of tic that cannot read from stdin, so we
+    restore_colors, save_colors, set_mode
-# create a temp file for it
+)
-tmp=$(mktemp)
+from ..tui.utils import kitty_opts, running_in_tmux
-cat >$tmp << 'TERMEOF'
+from .config import init_config
-TERMINFO
+from .copy import CopyInstruction
-TERMEOF
+from .options.types import Options as SSHOptions
-
+from .options.utils import DELETE_ENV_VAR
-tname=.terminfo
+from .utils import create_shared_memory, ssh_options
-if [ -e "/usr/share/misc/terminfo.cdb" ]; then
-    # NetBSD requires this see https://github.com/kovidgoyal/kitty/issues/4622
-    tname=".terminfo.cdb"
-fi
-tic_out=$(tic -x -o $HOME/$tname $tmp 2>&1)
-rc=$?
-rm $tmp
-if [ "$rc" != "0" ]; then echo "$tic_out"; exit 1; fi
-if [ -z "$USER" ]; then export USER=$(whoami); fi
-export TERMINFO="$HOME/$tname"
-login_shell=""
-python=""
-
-login_shell_is_ok() {
-    if [ -z "$login_shell" ] || [ ! -x "$login_shell" ]; then return 1; fi
-    case "$login_shell" in
-        *sh) return 0;
-    esac
-    return 1;
-}
-
-detect_python() {
-    python=$(command -v python3)
-    if [ -z "$python" ]; then python=$(command -v python2); fi
-    if [ -z "$python" ]; then python=python; fi
-}
-
-using_getent() {
-    cmd=$(command -v getent)
-    if [ -z "$cmd" ]; then return; fi
-    output=$($cmd passwd $USER 2>/dev/null)
-    if [ $? = 0 ]; then login_shell=$(echo $output | cut -d: -f7); fi
-}
-
-using_id() {
-    cmd=$(command -v id)
-    if [ -z "$cmd" ]; then return; fi
-    output=$($cmd -P $USER 2>/dev/null)
-    if [ $? = 0 ]; then login_shell=$(echo $output | cut -d: -f7); fi
-}
-
-using_passwd() {
-    cmd=$(command -v grep)
-    if [ -z "$cmd" ]; then return; fi
-    output=$($cmd "^$USER:" /etc/passwd 2>/dev/null)
-    if [ $? = 0 ]; then login_shell=$(echo $output | cut -d: -f7); fi
-}
-
-using_python() {
-    detect_python
-    if [ ! -x "$python" ]; then return; fi
-    output=$($python -c "import pwd, os; print(pwd.getpwuid(os.geteuid()).pw_shell)")
-    if [ $? = 0 ]; then login_shell=$output; fi
-}
-
-execute_with_python() {
-    detect_python
-    exec $python -c "import os; os.execl('$login_shell', '-' '$shell_name')"
-}
-
-die() { echo "$*" 1>&2 ; exit 1; }
-
-using_getent
-if ! login_shell_is_ok; then using_id; fi
-if ! login_shell_is_ok; then using_python; fi
-if ! login_shell_is_ok; then using_passwd; fi
-if ! login_shell_is_ok; then die "Could not detect login shell"; fi
 
 
-# If a command was passed to SSH execute it here
+@run_once
-EXEC_CMD
+def ssh_exe() -> str:
-
+    return shutil.which('ssh') or 'ssh'
-# We need to pass the first argument to the executed program with a leading -
-# to make sure the shell executes as a login shell. Note that not all shells
-# support exec -a so we use the below to try to detect such shells
-shell_name=$(basename $login_shell)
-if [ -z "$PIPESTATUS" ]; then
-    # the dash shell does not support exec -a and also does not define PIPESTATUS
-    execute_with_python
-fi
-exec -a "-$shell_name" $login_shell
-'''
 
 
-PYTHON_SCRIPT = '''\
+def read_data_from_shared_memory(shm_name: str) -> Any:
-#!/usr/bin/env python
+    with SharedMemory(shm_name, readonly=True) as shm:
-from __future__ import print_function
+        shm.unlink()
-from tempfile import NamedTemporaryFile
+        if shm.stats.st_uid != os.geteuid() or shm.stats.st_gid != os.getegid():
-import subprocess, os, sys, pwd, binascii, json
+            raise ValueError('Incorrect owner on pwfile')
+        mode = stat.S_IMODE(shm.stats.st_mode)
+        if mode != stat.S_IREAD:
+            raise ValueError('Incorrect permissions on pwfile')
+        return json.loads(shm.read_data_with_size())
 
-# macOS ships with an ancient version of tic that cannot read from stdin, so we
+
-# create a temp file for it
+# See https://www.gnu.org/software/bash/manual/html_node/Double-Quotes.html
-with NamedTemporaryFile() as tmp:
+quote_pat = re.compile('([\\`"])')
-    tname = '.terminfo'
+
-    if os.path.exists('/usr/share/misc/terminfo.cdb'):
+
-        tname += '.cdb'
+def quote_env_val(x: str, literal_quote: bool = False) -> str:
-    tmp.write(binascii.unhexlify('{terminfo}'))
+    if literal_quote:
-    tmp.flush()
+        return as_str_literal(x)
-    p = subprocess.Popen(['tic', '-x', '-o', os.path.expanduser('~/' + tname), tmp.name], stdout=subprocess.PIPE, stderr=subprocess.PIPE)
+    x = quote_pat.sub(r'\\\1', x)
-    stdout, stderr = p.communicate()
+    x = x.replace('$(', r'\$(')  # prevent execution with $()
-    if p.wait() != 0:
+    return f'"{x}"'
-        getattr(sys.stderr, 'buffer', sys.stderr).write(stdout + stderr)
+
-        raise SystemExit('Failed to compile terminfo using tic')
+
-command_to_execute = json.loads(binascii.unhexlify('{command_to_execute}'))
+def serialize_env(literal_env: Dict[str, str], env: Dict[str, str], base_env: Dict[str, str], for_python: bool = False) -> bytes:
-try:
+    lines = []
-    shell_path = pwd.getpwuid(os.geteuid()).pw_shell or '/bin/sh'
+    literal_quote = True
-except KeyError:
+
-    shell_path = '/bin/sh'
+    if for_python:
-shell_name = '-' + os.path.basename(shell_path)
+        def a(k: str, val: str = '', prefix: str = 'export') -> None:
-if command_to_execute:
+            if val:
-    os.execlp(shell_path, shell_path, '-c', command_to_execute)
+                lines.append(f'{prefix} {json.dumps((k, val, literal_quote))}')
-os.execlp(shell_path, shell_name)
+            else:
-'''
+                lines.append(f'{prefix} {json.dumps((k,))}')
+    else:
+        def a(k: str, val: str = '', prefix: str = 'export') -> None:
+            if val:
+                lines.append(f'{prefix} {shlex.quote(k)}={quote_env_val(val, literal_quote)}')
+            else:
+                lines.append(f'{prefix} {shlex.quote(k)}')
+
+    for k, v in literal_env.items():
+        a(k, v)
+
+    literal_quote = False
+    for k in sorted(env):
+        v = env[k]
+        if v == DELETE_ENV_VAR:
+            a(k, prefix='unset')
+        elif v == '_kitty_copy_env_var_':
+            q = base_env.get(k)
+            if q is not None:
+                a(k, q)
+        else:
+            a(k, v)
+    return '\n'.join(lines).encode('utf-8')
+
+
+def make_tarfile(ssh_opts: SSHOptions, base_env: Dict[str, str], compression: str = 'gz', literal_env: Dict[str, str] = {}) -> bytes:
+
+    def normalize_tarinfo(tarinfo: tarfile.TarInfo) -> tarfile.TarInfo:
+        tarinfo.uname = tarinfo.gname = ''
+        tarinfo.uid = tarinfo.gid = 0
+        # some distro's like nix mess with installed file permissions so ensure
+        # files are at least readable and writable by owning user
+        tarinfo.mode |= stat.S_IWUSR | stat.S_IRUSR
+        return tarinfo
+
+    def add_data_as_file(tf: tarfile.TarFile, arcname: str, data: Union[str, bytes]) -> tarfile.TarInfo:
+        ans = tarfile.TarInfo(arcname)
+        ans.mtime = 0
+        ans.type = tarfile.REGTYPE
+        if isinstance(data, str):
+            data = data.encode('utf-8')
+        ans.size = len(data)
+        normalize_tarinfo(ans)
+        tf.addfile(ans, io.BytesIO(data))
+        return ans
+
+    def filter_from_globs(*pats: str) -> Callable[[tarfile.TarInfo], Optional[tarfile.TarInfo]]:
+        def filter(tarinfo: tarfile.TarInfo) -> Optional[tarfile.TarInfo]:
+            for junk_dir in ('.DS_Store', '__pycache__'):
+                for pat in (f'*/{junk_dir}', f'*/{junk_dir}/*'):
+                    if fnmatch.fnmatch(tarinfo.name, pat):
+                        return None
+            for pat in pats:
+                if fnmatch.fnmatch(tarinfo.name, pat):
+                    return None
+            return normalize_tarinfo(tarinfo)
+        return filter
+
+    from kitty.shell_integration import get_effective_ksi_env_var
+    if ssh_opts.shell_integration == 'inherited':
+        ksi = get_effective_ksi_env_var(kitty_opts())
+    else:
+        from kitty.options.types import Options
+        from kitty.options.utils import shell_integration
+        ksi = get_effective_ksi_env_var(Options({'shell_integration': shell_integration(ssh_opts.shell_integration)}))
+
+    env = {
+        'TERM': os.environ.get('TERM') or kitty_opts().term,
+        'COLORTERM': 'truecolor',
+    }
+    env.update(ssh_opts.env)
+    for q in ('KITTY_WINDOW_ID', 'WINDOWID'):
+        val = os.environ.get(q)
+        if val is not None:
+            env[q] = val
+    env['KITTY_SHELL_INTEGRATION'] = ksi or DELETE_ENV_VAR
+    env['KITTY_SSH_KITTEN_DATA_DIR'] = ssh_opts.remote_dir
+    if ssh_opts.login_shell:
+        env['KITTY_LOGIN_SHELL'] = ssh_opts.login_shell
+    if ssh_opts.cwd:
+        env['KITTY_LOGIN_CWD'] = ssh_opts.cwd
+    if ssh_opts.remote_kitty != 'no':
+        env['KITTY_REMOTE'] = ssh_opts.remote_kitty
+    if os.environ.get('KITTY_PUBLIC_KEY'):
+        env['KITTY_PUBLIC_KEY'] = os.environ['KITTY_PUBLIC_KEY']
+    env_script = serialize_env(literal_env, env, base_env, for_python=compression != 'gz')
+    buf = io.BytesIO()
+    with tarfile.open(mode=f'w:{compression}', fileobj=buf, encoding='utf-8') as tf:
+        rd = ssh_opts.remote_dir.rstrip('/')
+        for ci in ssh_opts.copy.values():
+            tf.add(ci.local_path, arcname=ci.arcname, filter=filter_from_globs(*ci.exclude_patterns))
+        add_data_as_file(tf, 'data.sh', env_script)
+        if compression == 'gz':
+            tf.add(f'{shell_integration_dir}/ssh/bootstrap-utils.sh', arcname='bootstrap-utils.sh', filter=normalize_tarinfo)
+        if ksi:
+            arcname = 'home/' + rd + '/shell-integration'
+            tf.add(shell_integration_dir, arcname=arcname, filter=filter_from_globs(
+                f'{arcname}/ssh/*',          # bootstrap files are sent as command line args
+                f'{arcname}/zsh/kitty.zsh',  # present for legacy compat not needed by ssh kitten
+            ))
+        if ssh_opts.remote_kitty != 'no':
+            arcname = 'home/' + rd + '/kitty'
+            add_data_as_file(tf, arcname + '/version', str_version.encode('ascii'))
+            tf.add(shell_integration_dir + '/ssh/kitty', arcname=arcname + '/bin/kitty', filter=normalize_tarinfo)
+        tf.add(f'{terminfo_dir}/kitty.terminfo', arcname='home/.terminfo/kitty.terminfo', filter=normalize_tarinfo)
+        tf.add(glob.glob(f'{terminfo_dir}/*/xterm-kitty')[0], arcname='home/.terminfo/x/xterm-kitty', filter=normalize_tarinfo)
+    return buf.getvalue()
+
+
+def get_ssh_data(msg: str, request_id: str) -> Iterator[bytes]:
+    yield b'\nKITTY_DATA_START\n'  # to discard leading data
+    try:
+        msg = standard_b64decode(msg).decode('utf-8')
+        md = dict(x.split('=', 1) for x in msg.split(':'))
+        pw = md['pw']
+        pwfilename = md['pwfile']
+        rq_id = md['id']
+    except Exception:
+        traceback.print_exc()
+        yield b'invalid ssh data request message\n'
+    else:
+        try:
+            env_data = read_data_from_shared_memory(pwfilename)
+            if pw != env_data['pw']:
+                raise ValueError('Incorrect password')
+            if rq_id != request_id:
+                raise ValueError(f'Incorrect request id: {rq_id!r} expecting the KITTY_PID-KITTY_WINDOW_ID for the current kitty window')
+        except Exception as e:
+            traceback.print_exc()
+            yield f'{e}\n'.encode('utf-8')
+        else:
+            yield b'OK\n'
+            ssh_opts = SSHOptions(env_data['opts'])
+            ssh_opts.copy = {k: CopyInstruction(*v) for k, v in ssh_opts.copy.items()}
+            encoded_data = memoryview(env_data['tarfile'].encode('ascii'))
+            # macOS has a 255 byte limit on its input queue as per man stty.
+            # Not clear if that applies to canonical mode input as well, but
+            # better to be safe.
+            line_sz = 254
+            while encoded_data:
+                yield encoded_data[:line_sz]
+                yield b'\n'
+                encoded_data = encoded_data[line_sz:]
+            yield b'KITTY_DATA_END\n'
+
+
+def safe_remove(x: str) -> None:
+    with suppress(OSError):
+        os.remove(x)
+
+
+def prepare_script(ans: str, replacements: Dict[str, str], script_type: str) -> str:
+    for k in ('EXEC_CMD', 'EXPORT_HOME_CMD'):
+        replacements[k] = replacements.get(k, '')
+
+    def sub(m: 're.Match[str]') -> str:
+        return replacements[m.group()]
+
+    return re.sub('|'.join(fr'\b{k}\b' for k in replacements), sub, ans)
+
+
+def prepare_exec_cmd(remote_args: Sequence[str], is_python: bool) -> str:
+    # ssh simply concatenates multiple commands using a space see
+    # line 1129 of ssh.c and on the remote side sshd.c runs the
+    # concatenated command as shell -c cmd
+    if is_python:
+        return standard_b64encode(' '.join(remote_args).encode('utf-8')).decode('ascii')
+    args = ' '.join(c.replace("'", """'"'"'""") for c in remote_args)
+    return f"""unset KITTY_SHELL_INTEGRATION; exec "$login_shell" -c '{args}'"""
+
+
+def prepare_export_home_cmd(ssh_opts: SSHOptions, is_python: bool) -> str:
+    home = ssh_opts.env.get('HOME')
+    if home == '_kitty_copy_env_var_':
+        home = os.environ.get('HOME')
+    if home:
+        if is_python:
+            return standard_b64encode(home.encode('utf-8')).decode('ascii')
+        else:
+            return f'export HOME={quote_env_val(home)}; cd "$HOME"'
+    return ''
+
+
+def bootstrap_script(
+    ssh_opts: SSHOptions, script_type: str = 'sh', remote_args: Sequence[str] = (),
+    test_script: str = '', request_id: Optional[str] = None, cli_hostname: str = '', cli_uname: str = '',
+    request_data: bool = False, echo_on: bool = True, literal_env: Dict[str, str] = {}
+) -> Tuple[str, Dict[str, str], str]:
+    if request_id is None:
+        request_id = os.environ['KITTY_PID'] + '-' + os.environ['KITTY_WINDOW_ID']
+    is_python = script_type == 'py'
+    export_home_cmd = prepare_export_home_cmd(ssh_opts, is_python) if 'HOME' in ssh_opts.env else ''
+    exec_cmd = prepare_exec_cmd(remote_args, is_python) if remote_args else ''
+    with open(os.path.join(shell_integration_dir, 'ssh', f'bootstrap.{script_type}')) as f:
+        ans = f.read()
+    pw = secrets.token_hex()
+    tfd = standard_b64encode(make_tarfile(ssh_opts, dict(os.environ), 'gz' if script_type == 'sh' else 'bz2', literal_env=literal_env)).decode('ascii')
+    data = {'pw': pw, 'opts': ssh_opts._asdict(), 'hostname': cli_hostname, 'uname': cli_uname, 'tarfile': tfd}
+    shm_name = create_shared_memory(data, prefix=f'kssh-{os.getpid()}-')
+    sensitive_data = {'REQUEST_ID': request_id, 'DATA_PASSWORD': pw, 'PASSWORD_FILENAME': shm_name}
+    replacements = {
+        'EXPORT_HOME_CMD': export_home_cmd,
+        'EXEC_CMD': exec_cmd, 'TEST_SCRIPT': test_script,
+        'REQUEST_DATA': '1' if request_data else '0', 'ECHO_ON': '1' if echo_on else '0',
+    }
+    sd = replacements.copy()
+    if request_data:
+        sd.update(sensitive_data)
+    replacements.update(sensitive_data)
+    return prepare_script(ans, sd, script_type), replacements, shm_name
 
 
 def get_ssh_cli() -> Tuple[Set[str], Set[str]]:
@@ -148,13 +312,22 @@ def get_ssh_cli() -> Tuple[Set[str], Set[str]]:
     return boolean_ssh_args, other_ssh_args
 
 
-def get_connection_data(args: List[str], cwd: str = '') -> Optional[SSHConnectionData]:
+def is_extra_arg(arg: str, extra_args: Tuple[str, ...]) -> str:
+    for x in extra_args:
+        if arg == x or arg.startswith(f'{x}='):
+            return x
+    return ''
+
+
+def get_connection_data(args: List[str], cwd: str = '', extra_args: Tuple[str, ...] = ()) -> Optional[SSHConnectionData]:
     boolean_ssh_args, other_ssh_args = get_ssh_cli()
     port: Optional[int] = None
     expecting_port = expecting_identity = False
     expecting_option_val = False
     expecting_hostname = False
+    expecting_extra_val = ''
     host_name = identity_file = found_ssh = ''
+    found_extra_args: List[Tuple[str, str]] = []
 
     for i, arg in enumerate(args):
         if not found_ssh:
@@ -182,6 +355,15 @@ def get_connection_data(args: List[str], cwd: str = '') -> Optional[SSHConnectio
                 else:
                     identity_file = arg[2:]
                     continue
+            if arg.startswith('--') and extra_args:
+                matching_ex = is_extra_arg(arg, extra_args)
+                if matching_ex:
+                    if '=' in arg:
+                        exval = arg.partition('=')[-1]
+                        found_extra_args.append((matching_ex, exval))
+                        continue
+                    expecting_extra_val = matching_ex
+
             expecting_option_val = True
             continue
 
@@ -192,6 +374,9 @@ def get_connection_data(args: List[str], cwd: str = '') -> Optional[SSHConnectio
                 expecting_port = False
             elif expecting_identity:
                 identity_file = arg
+            elif expecting_extra_val:
+                found_extra_args.append((expecting_extra_val, arg))
+                expecting_extra_val = ''
             expecting_option_val = False
             continue
 
@@ -199,13 +384,22 @@ def get_connection_data(args: List[str], cwd: str = '') -> Optional[SSHConnectio
             host_name = arg
     if not host_name:
         return None
+    if host_name.startswith('ssh://'):
+        from urllib.parse import urlparse
+        purl = urlparse(host_name)
+        if purl.hostname:
+            host_name = purl.hostname
+        if purl.username:
+            host_name = f'{purl.username}@{host_name}'
+        if port is None and purl.port:
+            port = purl.port
     if identity_file:
         if not os.path.isabs(identity_file):
             identity_file = os.path.expanduser(identity_file)
         if not os.path.isabs(identity_file):
             identity_file = os.path.normpath(os.path.join(cwd or os.getcwd(), identity_file))
 
-    return SSHConnectionData(found_ssh, host_name, port, identity_file)
+    return SSHConnectionData(found_ssh, host_name, port, identity_file, tuple(found_extra_args))
 
 
 class InvalidSSHArgs(ValueError):
@@ -217,17 +411,21 @@ class InvalidSSHArgs(ValueError):
     def system_exit(self) -> None:
         if self.err_msg:
             print(self.err_msg, file=sys.stderr)
-        os.execlp('ssh', 'ssh')
+        os.execlp(ssh_exe(), 'ssh')
 
 
-def parse_ssh_args(args: List[str]) -> Tuple[List[str], List[str], bool]:
+passthrough_args = {f'-{x}' for x in 'NnfGT'}
+
+
+def parse_ssh_args(args: List[str], extra_args: Tuple[str, ...] = ()) -> Tuple[List[str], List[str], bool, Tuple[str, ...]]:
     boolean_ssh_args, other_ssh_args = get_ssh_cli()
-    passthrough_args = {f'-{x}' for x in 'Nnf'}
     ssh_args = []
     server_args: List[str] = []
     expecting_option_val = False
     passthrough = False
     stop_option_processing = False
+    found_extra_args: List[str] = []
+    expecting_extra_val = ''
     for argument in args:
         if len(server_args) > 1 or stop_option_processing:
             server_args.append(argument)
@@ -236,6 +434,16 @@ def parse_ssh_args(args: List[str]) -> Tuple[List[str], List[str], bool]:
             if argument == '--':
                 stop_option_processing = True
                 continue
+            if extra_args:
+                matching_ex = is_extra_arg(argument, extra_args)
+                if matching_ex:
+                    if '=' in argument:
+                        exval = argument.partition('=')[-1]
+                        found_extra_args.extend((matching_ex, exval))
+                    else:
+                        expecting_extra_val = matching_ex
+                        expecting_option_val = True
+                    continue
             # could be a multi-character option
             all_args = argument[1:]
             for i, arg in enumerate(all_args):
@@ -256,75 +464,298 @@ def parse_ssh_args(args: List[str]) -> Tuple[List[str], List[str], bool]:
                 raise InvalidSSHArgs(f'unknown option -- {arg[1:]}')
             continue
         if expecting_option_val:
-            ssh_args.append(argument)
+            if expecting_extra_val:
+                found_extra_args.extend((expecting_extra_val, argument))
+                expecting_extra_val = ''
+            else:
+                ssh_args.append(argument)
             expecting_option_val = False
             continue
         server_args.append(argument)
     if not server_args:
         raise InvalidSSHArgs()
-    return ssh_args, server_args, passthrough
+    return ssh_args, server_args, passthrough, tuple(found_extra_args)
 
 
-def quote(x: str) -> str:
+def wrap_bootstrap_script(sh_script: str, interpreter: str) -> List[str]:
-    # we have to escape unbalanced quotes and other unparsable
+    # sshd will execute the command we pass it by join all command line
-    # args as they will break the shell script
+    # arguments with a space and passing it as a single argument to the users
-    # But we do not want to quote things like * or 'echo hello'
+    # login shell with -c. If the user has a non POSIX login shell it might
-    # See https://github.com/kovidgoyal/kitty/issues/1787
+    # have different escaping semantics and syntax, so the command it should
-    try:
+    # execute has to be as simple as possible, basically of the form
-        shlex.split(x)
+    # interpreter -c unwrap_script escaped_bootstrap_script
-    except ValueError:
+    # The unwrap_script is responsible for unescaping the bootstrap script and
-        x = shlex.quote(x)
+    # executing it.
-    return x
+    q = os.path.basename(interpreter).lower()
+    is_python = 'python' in q
+    if is_python:
+        es = standard_b64encode(sh_script.encode('utf-8')).decode('ascii')
+        unwrap_script = '''"import base64, sys; eval(compile(base64.standard_b64decode(sys.argv[-1]), 'bootstrap.py', 'exec'))"'''
+    else:
+        # We cant rely on base64 being available on the remote system, so instead
+        # we quote the bootstrap script by replacing ' and \ with \v and \f
+        # also replacing \n and ! with \r and \b for tcsh
+        # finally surrounding with '
+        es = "'" + sh_script.replace("'", '\v').replace('\\', '\f').replace('\n', '\r').replace('!', '\b') + "'"
+        unwrap_script = r"""'eval "$(echo "$0" | tr \\\v\\\f\\\r\\\b \\\047\\\134\\\n\\\041)"' """
+    # exec is supported by all sh like shells, and fish and csh
+    return ['exec', interpreter, '-c', unwrap_script, es]
 
 
-def get_posix_cmd(terminfo: str, remote_args: List[str]) -> List[str]:
+def get_remote_command(
-    sh_script = SHELL_SCRIPT.replace('TERMINFO', terminfo, 1)
+    remote_args: List[str], ssh_opts: SSHOptions, cli_hostname: str = '', cli_uname: str = '',
-    command_to_execute = ''
+    echo_on: bool = True, request_data: bool = False, literal_env: Dict[str, str] = {}
-    if remote_args:
+) -> Tuple[List[str], Dict[str, str], str]:
-        # ssh simply concatenates multiple commands using a space see
+    interpreter = ssh_opts.interpreter
-        # line 1129 of ssh.c and on the remote side sshd.c runs the
+    q = os.path.basename(interpreter).lower()
-        # concatenated command as shell -c cmd
+    is_python = 'python' in q
-        args = [c.replace("'", """'"'"'""") for c in remote_args]
+    sh_script, replacements, shm_name = bootstrap_script(
-        command_to_execute = "exec $login_shell -c '{}'".format(' '.join(args))
+        ssh_opts, script_type='py' if is_python else 'sh', remote_args=remote_args, literal_env=literal_env,
-    sh_script = sh_script.replace('EXEC_CMD', command_to_execute)
+        cli_hostname=cli_hostname, cli_uname=cli_uname, echo_on=echo_on, request_data=request_data)
-    return [f'sh -c {shlex.quote(sh_script)}']
+    return wrap_bootstrap_script(sh_script, interpreter), replacements, shm_name
 
 
-def get_python_cmd(terminfo: str, command_to_execute: List[str]) -> List[str]:
+def connection_sharing_args(kitty_pid: int) -> List[str]:
-    import json
+    rd = runtime_dir()
-    script = PYTHON_SCRIPT.format(
+    # Bloody OpenSSH generates a 40 char hash and in creating the socket
-        terminfo=terminfo.encode('utf-8').hex(),
+    # appends a 27 char temp suffix to it. Socket max path length is approx
-        command_to_execute=json.dumps(' '.join(command_to_execute)).encode('utf-8').hex()
+    # ~104 chars. macOS has no system runtime dir so we use a cache dir in
+    # /Users/WHY_DOES_ANYONE_USE_MACOS/Library/Caches/APPLE_ARE_IDIOTIC
+    if len(rd) > 35 and os.path.isdir('/tmp'):
+        idiotic_design = f'/tmp/kssh-rdir-{os.getuid()}'
+        try:
+            os.symlink(rd, idiotic_design)
+        except FileExistsError:
+            try:
+                dest = os.readlink(idiotic_design)
+            except OSError as e:
+                raise ValueError(f'The {idiotic_design} symlink could not be created as something with that name exists already') from e
+            else:
+                if dest != rd:
+                    with tempfile.TemporaryDirectory(dir='/tmp') as tdir:
+                        tlink = os.path.join(tdir, 'sigh')
+                        os.symlink(rd, tlink)
+                        os.rename(tlink, idiotic_design)
+        rd = idiotic_design
+
+    cp = os.path.join(rd, ssh_control_master_template.format(kitty_pid=kitty_pid, ssh_placeholder='%C'))
+    ans: List[str] = [
+        '-o', 'ControlMaster=auto',
+        '-o', f'ControlPath={cp}',
+        '-o', 'ControlPersist=yes',
+        '-o', 'ServerAliveInterval=60',
+        '-o', 'ServerAliveCountMax=5',
+        '-o', 'TCPKeepAlive=no',
+    ]
+    return ans
+
+
+@contextmanager
+def restore_terminal_state() -> Iterator[bool]:
+    with open(os.ctermid()) as f:
+        val = termios.tcgetattr(f.fileno())
+        print(end=SAVE_PRIVATE_MODE_VALUES)
+        print(end=set_mode(Mode.HANDLE_TERMIOS_SIGNALS), flush=True)
+        try:
+            yield bool(val[3] & termios.ECHO)
+        finally:
+            termios.tcsetattr(f.fileno(), termios.TCSAFLUSH, val)
+            print(end=RESTORE_PRIVATE_MODE_VALUES, flush=True)
+
+
+def dcs_to_kitty(payload: Union[bytes, str], type: str = 'ssh') -> bytes:
+    if isinstance(payload, str):
+        payload = payload.encode('utf-8')
+    payload = standard_b64encode(payload)
+    ans = b'\033P@kitty-' + type.encode('ascii') + b'|' + payload
+    tmux = running_in_tmux()
+    if tmux:
+        cp = subprocess.run([tmux, 'set', '-p', 'allow-passthrough', 'on'])
+        if cp.returncode != 0:
+            raise SystemExit(cp.returncode)
+        ans = b'\033Ptmux;\033' + ans + b'\033\033\\\033\\'
+    else:
+        ans += b'\033\\'
+    return ans
+
+
+@run_once
+def ssh_version() -> Tuple[int, int]:
+    o = subprocess.check_output([ssh_exe(), '-V'], stderr=subprocess.STDOUT).decode()
+    m = re.match(r'OpenSSH_(\d+).(\d+)', o)
+    if m is None:
+        raise ValueError(f'Invalid version string for OpenSSH: {o}')
+    return int(m.group(1)), int(m.group(2))
+
+
+@contextmanager
+def drain_potential_tty_garbage(p: 'subprocess.Popen[bytes]', data_request: str) -> Iterator[None]:
+    with open(os.open(os.ctermid(), os.O_CLOEXEC | os.O_RDWR | os.O_NOCTTY), 'wb') as tty:
+        if data_request:
+            turn_off_echo(tty.fileno())
+            tty.write(dcs_to_kitty(data_request))
+            tty.flush()
+        try:
+            yield
+        finally:
+            # discard queued input data on tty in case data transmission was
+            # interrupted due to SSH failure, avoids spewing garbage to screen
+            from uuid import uuid4
+            canary = uuid4().hex.encode('ascii')
+            turn_off_echo(tty.fileno())
+            tty.write(dcs_to_kitty(canary + b'\n\r', type='echo'))
+            tty.flush()
+            data = b''
+            give_up_at = time.monotonic() + 2
+            tty_fd = tty.fileno()
+            while time.monotonic() < give_up_at and canary not in data:
+                with suppress(KeyboardInterrupt):
+                    rd, wr, err = select([tty_fd], [], [tty_fd], max(0, give_up_at - time.monotonic()))
+                    if err or not rd:
+                        break
+                    q = os.read(tty_fd, io.DEFAULT_BUFFER_SIZE)
+                    if not q:
+                        break
+                    data += q
+
+
+def change_colors(color_scheme: str) -> bool:
+    if not color_scheme:
+        return False
+    from kittens.themes.collection import (
+        NoCacheFound, load_themes, text_as_opts
     )
-    return [f'python -c "{script}"']
+    from kittens.themes.main import colors_as_escape_codes
+    if color_scheme.endswith('.conf'):
+        conf_file = resolve_abs_or_config_path(color_scheme)
+        try:
+            with open(conf_file) as f:
+                opts = text_as_opts(f.read())
+        except FileNotFoundError:
+            raise SystemExit(f'Failed to find the color conf file: {expandvars(conf_file)}')
+    else:
+        try:
+            themes = load_themes(-1)
+        except NoCacheFound:
+            themes = load_themes()
+        cs = expandvars(color_scheme)
+        try:
+            theme = themes[cs]
+        except KeyError:
+            raise SystemExit(f'Failed to find the color theme: {cs}')
+        opts = theme.kitty_opts
+    raw = colors_as_escape_codes(opts)
+    print(save_colors(), sep='', end=raw, flush=True)
+    return True
 
 
-def main(args: List[str]) -> NoReturn:
+def add_cloned_env(shm_name: str) -> Dict[str, str]:
-    args = args[1:]
-    use_posix = True
-    if args and args[0] == 'use-python':
-        args = args[1:]
-        use_posix = False
     try:
-        ssh_args, server_args, passthrough = parse_ssh_args(args)
+        return cast(Dict[str, str], read_data_from_shared_memory(shm_name))
+    except FileNotFoundError:
+        pass
+    return {}
+
+
+def run_ssh(ssh_args: List[str], server_args: List[str], found_extra_args: Tuple[str, ...]) -> NoReturn:
+    cmd = [ssh_exe()] + ssh_args
+    hostname, remote_args = server_args[0], server_args[1:]
+    if not remote_args:
+        cmd.append('-t')
+    insertion_point = len(cmd)
+    cmd.append('--')
+    cmd.append(hostname)
+    uname = getuser()
+    if hostname.startswith('ssh://'):
+        from urllib.parse import urlparse
+        purl = urlparse(hostname)
+        hostname_for_match = purl.hostname or hostname[6:].split('/', 1)[0]
+        uname = purl.username or uname
+    elif '@' in hostname and hostname[0] != '@':
+        uname, hostname_for_match = hostname.split('@', 1)
+    else:
+        hostname_for_match = hostname
+    hostname_for_match = hostname_for_match.split('@', 1)[-1].split(':', 1)[0]
+    overrides: List[str] = []
+    literal_env: Dict[str, str] = {}
+    pat = re.compile(r'^([a-zA-Z0-9_]+)[ \t]*=')
+    for i, a in enumerate(found_extra_args):
+        if i % 2 == 1:
+            aq = pat.sub(r'\1 ', a.lstrip())
+            key = aq.split(maxsplit=1)[0]
+            if key == 'clone_env':
+                literal_env = add_cloned_env(aq.split(maxsplit=1)[1])
+            elif key != 'hostname':
+                overrides.append(aq)
+    if overrides:
+        overrides.insert(0, f'hostname {uname}@{hostname_for_match}')
+    host_opts = init_config(hostname_for_match, uname, overrides)
+    if host_opts.share_connections:
+        cmd[insertion_point:insertion_point] = connection_sharing_args(int(os.environ['KITTY_PID']))
+    use_kitty_askpass = host_opts.askpass == 'native' or (host_opts.askpass == 'unless-set' and 'SSH_ASKPASS' not in os.environ)
+    need_to_request_data = True
+    if use_kitty_askpass:
+        sentinel = os.path.join(cache_dir(), 'openssh-is-new-enough-for-askpass')
+        sentinel_exists = os.path.exists(sentinel)
+        if sentinel_exists or ssh_version() >= (8, 4):
+            if not sentinel_exists:
+                open(sentinel, 'w').close()
+            # SSH_ASKPASS_REQUIRE was introduced in 8.4 release on 2020-09-27
+            need_to_request_data = False
+            os.environ['SSH_ASKPASS_REQUIRE'] = 'force'
+        os.environ['SSH_ASKPASS'] = os.path.join(shell_integration_dir, 'ssh', 'askpass.py')
+    if need_to_request_data and host_opts.share_connections:
+        cp = subprocess.run(cmd[:1] + ['-O', 'check'] + cmd[1:], stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL)
+        if cp.returncode == 0:
+            # we will use the master connection so SSH does not need to use the tty
+            need_to_request_data = False
+    with restore_terminal_state() as echo_on:
+        rcmd, replacements, shm_name = get_remote_command(
+            remote_args, host_opts, hostname_for_match, uname, echo_on, request_data=need_to_request_data, literal_env=literal_env)
+        cmd += rcmd
+        colors_changed = change_colors(host_opts.color_scheme)
+        try:
+            p = subprocess.Popen(cmd)
+        except FileNotFoundError:
+            raise SystemExit('Could not find the ssh executable, is it in your PATH?')
+        else:
+            rq = '' if need_to_request_data else 'id={REQUEST_ID}:pwfile={PASSWORD_FILENAME}:pw={DATA_PASSWORD}'.format(**replacements)
+            with drain_potential_tty_garbage(p, rq):
+                raise SystemExit(p.wait())
+        finally:
+            if colors_changed:
+                print(end=restore_colors(), flush=True)
+
+
+def main(args: List[str]) -> None:
+    args = args[1:]
+    if args and args[0] == 'use-python':
+        args = args[1:]  # backwards compat from when we had a python implementation
+    try:
+        ssh_args, server_args, passthrough, found_extra_args = parse_ssh_args(args, extra_args=('--kitten',))
     except InvalidSSHArgs as e:
         e.system_exit()
-    cmd = ['ssh'] + ssh_args
     if passthrough:
-        cmd += server_args
+        if found_extra_args:
-    else:
+            raise SystemExit(f'The SSH kitten cannot work with the options: {", ".join(passthrough_args)}')
-        hostname, remote_args = server_args[0], server_args[1:]
+        os.execlp(ssh_exe(), 'ssh', *args)
-        if not remote_args:
+
-            cmd.append('-t')
+    if not os.environ.get('KITTY_WINDOW_ID') or not os.environ.get('KITTY_PID'):
-        cmd.append('--')
+        raise SystemExit('The SSH kitten is meant to run inside a kitty window')
-        cmd.append(hostname)
+    if not sys.stdin.isatty():
-        terminfo = subprocess.check_output(['infocmp', '-a']).decode('utf-8')
+        raise SystemExit('The SSH kitten is meant for interactive use only, STDIN must be a terminal')
-        f = get_posix_cmd if use_posix else get_python_cmd
+    try:
-        cmd += f(terminfo, remote_args)
+        run_ssh(ssh_args, server_args, found_extra_args)
-    os.execvp('ssh', cmd)
+    except KeyboardInterrupt:
+        sys.excepthook = lambda *a: None
+        raise
 
 
 if __name__ == '__main__':
     main(sys.argv)
 elif __name__ == '__completer__':
+    from .completion import complete
     setattr(sys, 'kitten_completer', complete)
+elif __name__ == '__conf__':
+    from .options.definition import definition
+    sys.options_definition = definition  # type: ignore