Skip to content

Commit

Permalink
built-in pager: document key bindings
Browse files Browse the repository at this point in the history
I mostly focused on:

- keys for absolute beginners
- keys for features for which it's not obvious they
  *have* a key binding
  • Loading branch information
ilyagr committed Jan 29, 2025
1 parent fd31096 commit cb63713
Showing 1 changed file with 17 additions and 1 deletion.
18 changes: 17 additions & 1 deletion docs/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -588,7 +588,23 @@ Our builtin pager is based on
[`streampager`](https://github.com/markbt/streampager/) but is configured within
`jj`'s config. It is configured via the `ui.streampager` table.

#### Wrapping
#### Key bindings

The built-in pager supports both navigation via arrows and Vim-style navigation.
Beyond that, here are some useful keybindings for the pager:

| Key | Action |
| :-------------- | :-------------------- |
| `Ctrl-c` or `q` | Quit |
| `h` or `F1` | Show all key bindings |
| `Esc` | Close help or prompt |
| `\` | Toggle line wrapping |
| `#` | Toggle line numbers |
| `Ctrl-r` | Toggle the ruler |

The built-in pager does not support mouse input.

#### Wrapping config

Wrapping performed by the pager happens *in addition to* any
wrapping that `jj` itself does.
Expand Down

0 comments on commit cb63713

Please sign in to comment.