Add a note that startup_session prevents processing of cli args

This commit is contained in:
Kovid Goyal 2024-03-07 08:51:51 +05:30
parent 6c31256aa1
commit 9ea0dde469
No known key found for this signature in database
GPG key ID: 06BC317B515ACE7C
2 changed files with 5 additions and 2 deletions

View file

@ -896,11 +896,13 @@ def options_spec() -> str:
--session
completion=type:file ext:session relative:conf group:"Session files"
Path to a file containing the startup :italic:`session` (tabs, windows, layout,
programs). Use - to read from STDIN. See the :file:`README` file for details and
programs). Use - to read from STDIN. See :ref:`sessions` for details and
an example. Environment variables in the file name are expanded,
relative paths are resolved relative to the kitty configuration directory.
The special value :code:`none` means no session will be used, even if
the :opt:`startup_session` option has been specified in kitty.conf.
Note that using this option means the command line arguments to kitty specifying
a program to run are ignored.
--hold

View file

@ -3057,7 +3057,8 @@
instances. See :ref:`sessions` in the kitty documentation for details. Note that
relative paths are interpreted with respect to the kitty config directory.
Environment variables in the path are expanded. Changing this option by
reloading the config is not supported.
reloading the config is not supported. Note that this prevents kitty from processing
any command line arguments as a program to run.
'''
)