mirrors/kitty
1
0
Fork 0
mirror of https://github.com/kovidgoyal/kitty synced 2026-06-11 19:19:35 +02:00
Code Issues Packages Projects Releases Wiki Activity

Document the save_as_session action

Browse Source
This commit is contained in:
Kovid Goyal
2025-08-17 14:44:26 +05:30
parent 34ae42cf30
commit a2d76a6c34
4 changed files with 28 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
docs/conf.py
View File

@@ -237,6 +237,13 @@ def write_cli_docs(all_kitten_names: Iterable[str]) -> None:
usage='file-or-dir-to-copy ...', message=copy_message
))
del sys.modules['kittens.ssh.main']
from kitty.session import save_as_session_message, save_as_session_options
with open('generated/save-as-session.rst', 'w') as f:
f.write(option_spec_as_rst(
appname='save_as_session', ospec=save_as_session_options, heading_char='^',
usage='[path-to-save-session-file-at]',
message=save_as_session_message,
))
from kitty.launch import options_spec as launch_options_spec
with open('generated/launch.rst', 'w') as f:

15
docs/sessions.rst
View File

@@ -210,10 +210,10 @@ documentation for them.
title behaves just as for a regular tab in kitty.
``os_window_class``
Set the :option:`class part of WM_CLASS or Wayland Application Id <kitty --class>` for the current OS Window
Set the class part of WM_CLASS or Wayland Application Id for the current OS Window
``os_window_name``
Set the :option:`name part of WM_CLASS or Wayland Window tag <kitty --name>` for the current OS Window
Set the name part of WM_CLASS or Wayland Window tag for the current OS Window
``os_window_size``
Set the size of the current OS Window, can be specified in pixels or cells.
@@ -236,3 +236,14 @@ documentation for them.
instead.
.. _save_as_session:
The save_as_session action
------------------------------
This action can be mapped to a key press in :file:`kitty.conf`. It will save
the currently open OS Windows, tabs, windows, running programs, working
directories, etc. into a session file. It is a convenient way to
:ref:`complex_sessions`. The options this action takes are documented below.
.. include:: generated/save-as-session.rst