1
1
mirror of https://github.com/wez/wezterm.git synced 2025-01-01 18:22:13 +03:00
wezterm/docs/config/lua/keyassignment/ScrollToPrompt.md
Benoit de Chezelles f37c3ae5da
Fix some documentation pages (#3321)
* Update ssh_backend.md

* Update normalize_output_to_unicode_nfc.md

* Update strikethrough_position.md

* Update underline_position.md

* Update underline_thickness.md

* Fix lua config docs titles to be formatted as inline code

* Mention how suggested alphabet for quick select is choosen

* Mention update-status and update-right-status for status_update_interval

* Fix docs for all keyassignments to be formatted as inline code

* Fix Lua object index titles

* Fix titles of `wezterm.*` module index pages

* Fix title of `Color` object & `wezterm.color` functions

We reduce titles from h2 to h1 because mkdocs defaults the page title to
the page file name if no h1 header is found.

* Unify title of all object methods

* Add index page for Gui events
2023-03-22 06:36:03 -07:00

33 lines
1.1 KiB
Markdown

# `ScrollToPrompt`
{{since('20210203-095643-70a364eb')}}
This action operates on Semantic Zones defined by applications that use [OSC
133 Semantic Prompt Escapes](https://gitlab.freedesktop.org/Per_Bothner/specifications/blob/master/proposals/semantic-prompts.md) and requires configuring your shell to emit those sequences.
OSC 133 escapes allow marking regions of output as `Output` (from the commands
that you run), `Input` (that you type) and `Prompt` ("chrome" from your shell).
This action allows scrolling to the start of a `Prompt` zone; it takes an
argument that specifies the number of zones to move and the direction to move
in; `-1` means to move to the previous zone while `1` means to move to the next
zone.
This can make it convenient to skip over large amounts of output.
This action is not bound by default.
For the purposes of scrolling, the "current zone" is considered to be the one
closest to the top of the viewport.
```lua
local act = wezterm.action
config.keys = {
{ key = 'UpArrow', mods = 'SHIFT', action = act.ScrollToPrompt(-1) },
{ key = 'DownArrow', mods = 'SHIFT', action = act.ScrollToPrompt(1) },
}
```