Improve formatting of --stdin-source

This commit is contained in:
Kovid Goyal 2022-08-19 09:34:52 +05:30
parent 3f4588c408
commit 30df4e5de2
No known key found for this signature in database
GPG Key ID: 06BC317B515ACE7C

View File

@ -186,17 +186,32 @@ type=choices
default=none
choices=none,@selection,@screen,@screen_scrollback,@alternate,@alternate_scrollback,@first_cmd_output_on_screen,@last_cmd_output,@last_visited_cmd_output
Pass the screen contents as :file:`STDIN` to the child process.
:code:`@selection` is the currently selected text. :code:`@screen` is the
contents of the currently active window. :code:`@screen_scrollback` is the same
as :code:`@screen`, but includes the scrollback buffer as well.
:code:`@alternate` is the secondary screen of the current active window. For
example if you run a full screen terminal application, the secondary screen will
be the screen you return to when quitting the application.
:code:`@first_cmd_output_on_screen` is the output from the first command run in
the shell on screen, :code:`@last_cmd_output` is the output from the last
command run in the shell, :code:`@last_visited_cmd_output` is the first output
below the last scrolled position via :ac:`scroll_to_prompt`, this three needs
:ref:`shell integration <shell_integration>` to work.
:code:`@selection`
is the currently selected text.
:code:`@screen`
is the contents of the currently active window.
:code:`@screen_scrollback`
is the same as :code:`@screen`, but includes the scrollback buffer as well.
:code:`@alternate`
is the secondary screen of the current active window. For example if you run
a full screen terminal application, the secondary screen will
be the screen you return to when quitting the application.
:code:`@first_cmd_output_on_screen`
is the output from the first command run in the shell on screen.
:code:`@last_cmd_output`
is the output from the last command run in the shell.
:code:`@last_visited_cmd_output`
is the first output below the last scrolled position via :ac:`scroll_to_prompt`,
this needs :ref:`shell integration <shell_integration>` to work.
#placeholder_for_formatting#
--stdin-add-formatting