Skip to content

Commit

Permalink
Merge remote-tracking branch 'refs/remotes/origin/neovim-icon' into n…
Browse files Browse the repository at this point in the history 
…eovim-icon
  • Loading branch information
@mikesmithgh
mikesmithgh committed Nov 25, 2023
2 parents cd7b7ea + 9e12706 commit d95572d
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 15 deletions.
12 changes: 10 additions & 2 deletions doc/kitty-scrollback.nvim.txt
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
*kitty-scrollback.nvim.txt* For NVIM v0.9+ Last change: 2023 November 24
*kitty-scrollback.nvim.txt* For NVIM v0.9+ Last change: 2023 November 25

==============================================================================
Table of Contents *kitty-scrollback.nvim-table-of-contents*
Expand Down Expand Up @@ -401,7 +401,15 @@ KITTY-SCROLLBACK.NVIM CONFIGURATION FILE ~
status_window.show_timer boolean If true, show a timer in the status window while
kitty-scrollback.nvim is loading

paste_window KsbPasteWindowOpts? options for paste window that sends commands to Kitty
status_window.icons KsbStatusWindowIcons? Icons displayed in the status window, defaults to 󰄛 󰣐

status_window.icons.kitty string kittystatus window icon, defaults to 󰄛

status_window.icons.heart string heart string heart status window icon, defaults to 󰣐

status_window.icons.nvim string nvim status window icon, defaults to

paste_window KsbPasteWindowOpts? optionsfor paste window that sends commands to Kitty

paste_window.highlight_as_normal_win fun(): boolean? If function returns true, use Normal highlight group. If
false, use NormalFloat
Expand Down
36 changes: 23 additions & 13 deletions doc/kitty-scrollback.nvim_spec.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -61,14 +61,24 @@ KsbKittyGetText *kitty-scrollback.launch.KsbKittyGetText*
{extent} (string|"screen"|"all"|"selection"|"first_cmd_output_on_screen"|"last_cmd_output"|"last_visited_cmd_output"|"last_non_empty_output") What text to get. The default of screen means all text currently on the screen. all means all the screen+scrollback and selection means the currently selected text. first_cmd_output_on_screen means the output of the first command that was run in the window on screen. last_cmd_output means the output of the last command that was run in the window. last_visited_cmd_output means the first command output below the last scrolled position via scroll_to_prompt. last_non_empty_output is the output from the last command run in the window that had some non empty output. The last four require shell_integration to be enabled. Choices: screen, all, first_cmd_output_on_screen, last_cmd_output, last_non_empty_output, last_visited_cmd_output, selection


*kitty-scrollback.launch.KsbStatusWindowIcons*
KsbStatusWindowIcons

Fields: ~
{kitty} (string) kitty status window icon, defaults to 󰄛
{heart} (string) heart status window icon, defaults to 󰣐
{nvim} (string) nvim status window icon, defaults to 


*kitty-scrollback.launch.KsbStatusWindowOpts*
KsbStatusWindowOpts

Fields: ~
{enabled} (boolean) If true, show status window in upper right corner of the screen
{style_simple} (boolean) If true, use plaintext instead of nerd font icons
{autoclose} (boolean) If true, close the status window after kitty-scrollback.nvim is ready
{show_timer} (boolean) If true, show a timer in the status window while kitty-scrollback.nvim is loading
{enabled} (boolean) If true, show status window in upper right corner of the screen
{style_simple} (boolean) If true, use plaintext instead of nerd font icons
{autoclose} (boolean) If true, close the status window after kitty-scrollback.nvim is ready
{show_timer} (boolean) If true, show a timer in the status window while kitty-scrollback.nvim is loading
{icons} (KsbStatusWindowIcons) Icons displayed in the status window, defaults to 󰄛 󰣐 


KsbWinOpts *kitty-scrollback.launch.KsbWinOpts*
Expand Down Expand Up @@ -108,15 +118,15 @@ KsbPasteWindowOpts
KsbOpts *kitty-scrollback.launch.KsbOpts*

Fields: ~
{callbacks} (KsbCallbacks|nil) fire and forget callback functions
{keymaps_enabled} (boolean|nil) if true, enabled all default keymaps
{restore_options} (boolean|nil) if true, restore options that were modified while processing the scrollback buffer
{highlight_overrides} (KsbHighlights|nil) kitty-scrollback.nvim highlight overrides
{status_window} (KsbStatusWindowOpts|nil) options for status window indicating that kitty-scrollback.nvim is ready
{paste_window} (KsbPasteWindowOpts|nil) options for paste window that sends commands to Kitty
{kitty_get_text} (KsbKittyGetText|nil) options passed to get-text when reading scrollback buffer, see `kitty @ get-text --help`
{checkhealth} (boolean|nil) if true execute :checkhealth kitty-scrollback and skip setup
{visual_selection_highlight_mode} (string|"darken"|"kitty"|"nvim"|"reverse")
{callbacks} (KsbCallbacks|nil) fire and forget callback functions
{keymaps_enabled} (boolean|nil) if true, enabled all default keymaps
{restore_options} (boolean|nil) if true, restore options that were modified while processing the scrollback buffer
{highlight_overrides} (KsbHighlights|nil) kitty-scrollback.nvim highlight overrides
{status_window} (KsbStatusWindowOpts|nil) options for status window indicating that kitty-scrollback.nvim is ready
{paste_window} (KsbPasteWindowOpts|nil) options for paste window that sends commands to Kitty
{kitty_get_text} (KsbKittyGetText|nil) options passed to get-text when reading scrollback buffer, see `kitty @ get-text --help`
{checkhealth} (boolean|nil) if true execute :checkhealth kitty-scrollback and skip setup
{visual_selection_highlight_mode} (string|"darken"|"kitty"|"nvim"|"reverse"|nil)


M.setup({kitty_data_str}) *kitty-scrollback.launch.setup*
Expand Down

0 comments on commit d95572d

Please sign in to comment.