From 365583efd73fcdeb40521cb003a54e5d8df06bd1 Mon Sep 17 00:00:00 2001 From: Kovid Goyal Date: Fri, 4 Feb 2022 10:51:41 +0530 Subject: [PATCH] Clarify SI docs a little Fixes #4626 --- docs/shell-integration.rst | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/docs/shell-integration.rst b/docs/shell-integration.rst index 754586661..d4a0f55d9 100644 --- a/docs/shell-integration.rst +++ b/docs/shell-integration.rst @@ -48,11 +48,16 @@ off or it can be disabled entirely as well. The :opt:`shell_integration` option takes a space separated list of keywords: disabled - Turn off all shell integration + Turn off all shell integration. The shell's launch environment is not + modified and :env:`KITTY_SHELL_INTEGRATION` is not set. Useful for + :ref:`manual integration `. no-rc Do not modify the shell's launch environment to enable integration. Useful if you prefer - to :ref:`manually enable integration `. + to load the kitty shell integration code yourself, either as part of + :ref:`manually integration ` or because you have + some other software that sets up shell integration. + This will still set the :env:`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