From 6590d0690e204e859c50fe693f99ab38f45f46b3 Mon Sep 17 00:00:00 2001 From: Kovid Goyal Date: Sun, 17 Apr 2022 19:51:27 +0530 Subject: [PATCH] Document venv and sourcing behavior of clone-in-kitty --- docs/shell-integration.rst | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/docs/shell-integration.rst b/docs/shell-integration.rst index 22886cf7a..5343d0ede 100644 --- a/docs/shell-integration.rst +++ b/docs/shell-integration.rst @@ -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: