Document venv and sourcing behavior of clone-in-kitty

This commit is contained in:
Kovid Goyal 2022-04-17 19:51:27 +05:30
parent 230a9f4678
commit 6590d0690e
No known key found for this signature in database
GPG Key ID: 06BC317B515ACE7C

View File

@ -244,6 +244,15 @@ are ignored: :option:`launch --allow-remote-control`, :option:`launch
--allow-remote-control`, :option:`launch --stdin-source`, :option:`launch
--marker` and :option:`launch --watcher`.
:file:`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 python venv module or conda. In addition, setting the
env var :file:`KITTY_CLONE_SOURCE_PATH` to the path of a file will cause
that file to be sourced in the cloned window. Similarly, setting
:file:`KITTY_CLONE_SOURCE_CODE` to some shell code will cause that code to be
run in the cloned window with :code:`eval`. This can be controlled by
:opt:`clone_source_strategies`.
.. _manual_shell_integration: