Skip to content

Commit b401e12

Browse files
committed
Note how to use nvim as scrollback pager in the docs for that option
1 parent 7b0caaa commit b401e12

File tree

2 files changed

+9
-1
lines changed

2 files changed

+9
-1
lines changed

docs/overview.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -219,7 +219,7 @@ arbitrary, command running in a new :term:`window`, :term:`tab` or
219219
Would open the scrollback buffer in a new :term:`window` when you press the
220220
:kbd:`F1` key. See :sc:`show_scrollback <show_scrollback>` for details.
221221

222-
If you want to use it with an editor such as :program:`vim` to get more powerful
222+
If you want to use it with an editor such as :program:`nvim` to get more powerful
223223
features, see for example, `kitty-scrollback.nvim
224224
<https://github.com/mikesmithgh/kitty-scrollback.nvim>`__ or `kitty-grab <https://github.com/yurikhan/kitty_grab>`__
225225
or see more tips for using various editor programs, in :iss:`this thread <719>`.

kitty/options/definition.py

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -529,6 +529,14 @@
529529
CURSOR_LINE and CURSOR_COLUMN will be replaced by the current cursor position or
530530
set to 0 if there is no cursor, for example, when showing the last command
531531
output.
532+
533+
If you would rather use neovim to view the scrollback, use something like this::
534+
535+
scrollback_pager nvim --cmd 'set eventignore=FileType' +'nnoremap q ZQ' +'call nvim_open_term(0, {})' +'set nomodified nolist' +'$' -
536+
537+
The above works for neovim 0.12 and newer. There is also a dedicated plugin
538+
:link:`kitty-scrollback.nvim <https://github.com/mikesmithgh/kitty-scrollback.nvim>`
539+
you can use with more features that works with older neovim as well.
532540
'''
533541
)
534542

0 commit comments

Comments
 (0)