1
1
mirror of https://github.com/wez/wezterm.git synced 2024-12-26 23:04:49 +03:00
wezterm/docs/config/lua/keyassignment/ScrollToPrompt.md
Wez Furlong 0f8146b212
docs: shift from return {} style to config.something style
Nudge new users towards using this style:

```lua
local config = {}
config.color_scheme = 'Batman'
return config
```

and surface how to write lua modules closer to the main section
on config files. In that lua modules section, nudge towards using
a convention similar to that of the plugin spec described in
this commit: e4ae8a844d
2023-03-19 18:26:21 -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) },
}
```