From 3284d71300a1f7a9862d65342a889d6ce8f4efa9 Mon Sep 17 00:00:00 2001 From: "Michael G. Noll" Date: Fri, 1 Apr 2022 14:52:12 +0200 Subject: [PATCH] Clarify documentation of `macos_option_as_alt` See discussion at https://github.com/kovidgoyal/kitty/issues/4908 --- kitty/options/definition.py | 17 +++++++++++------ 1 file changed, 11 insertions(+), 6 deletions(-) diff --git a/kitty/options/definition.py b/kitty/options/definition.py index d18edf9e8..5bf4b2fb4 100644 --- a/kitty/options/definition.py +++ b/kitty/options/definition.py @@ -2820,12 +2820,17 @@ just hiding the titlebar with :opt:`hide_window_decorations`. opt('macos_option_as_alt', 'no', option_type='macos_option_as_alt', ctype='uint', long_text=''' -Use the option key as an alt key. With this set to :code:`no`, kitty will use -the macOS native :kbd:`Option+Key` = unicode character behavior. This will break -any :kbd:`Alt+key` keyboard shortcuts in your terminal programs, but you can use -the macOS unicode input technique. You can use the values: :code:`left`, -:code:`right`, or :code:`both` to use only the left, right or both Option keys -as Alt, instead. Changing this setting by reloading the config is not supported. +Use the :kbd:`Option` key as an :kbd:`Alt` key. With this set to :code:`no`, +kitty will use the macOS native :kbd:`Option+Key` = unicode character behavior. +This will break any :kbd:`Alt+Key` keyboard shortcuts in your terminal programs, +but you can use the macOS unicode input technique. You can use the values: +:code:`left`, :code:`right`, or :code:`both` to use only the left, right or both +:kbd:`Option` keys as :kbd:`Alt`, instead. Note that kitty itself always treats +:kbd:`Option` the same as :kbd:`Alt`. This means you cannot use this setting to +configure different kitty shortcuts for :kbd:`Option+Key` vs. `:kbd:`Alt+Key`. +Also, any kitty shortcuts using :kbd:`Option/Alt+Key` will take priority, so +that any such key presses will not be passed to terminal programs running inside +kitty. Changing this setting by reloading the config is not supported. ''' )