Skip to content
Browse files
patch 8.0.1712: terminal scrollback is not limited
Problem:    Terminal scrollback is not limited.
Solution:   Add the 'terminalscroll' option.
  • Loading branch information
brammool committed Apr 14, 2018
1 parent a42d363 commit 8c041b6b95f49f7383cf00e2036cf009b326fa8d
Showing with 54 additions and 7 deletions.
  1. +11 −1 runtime/doc/options.txt
  2. +8 −3 runtime/doc/terminal.txt
  3. +9 −0 src/option.c
  4. +3 −0 src/option.h
  5. +21 −3 src/terminal.c
  6. +2 −0 src/version.c
@@ -1,4 +1,4 @@
*options.txt* For Vim version 8.0. Last change: 2018 Mar 13
*options.txt* For Vim version 8.0. Last change: 2018 Apr 14

@@ -7933,6 +7933,16 @@ A jump table for the options with a short description can be found at |Q_op|.
Note that the "cterm" attributes are still used, not the "gui" ones.
NOTE: This option is reset when 'compatible' is set.

*'terminalscroll'* *'tlsl'*
'terminalscroll' 'tlsl' number (default 10000)
{not in Vi}
{not available when compiled without the
|+terminal| feature}
Number of scrollback lines to keep. When going over this limit the
first 10% of the scrollback lines are deleted. This is just to reduce
the memory usage. See |Terminal-Normal|.

*'termkey'* *'tk'*
'termkey' 'tk' string (default "")
local to window
@@ -288,7 +288,7 @@ not when 'termsize' is "rowsXcols".

Terminal-Job and Terminal-Normal mode ~
*Terminal-mode* *Terminal-Job*
When the job is running the contents of the terminal is under control of the
job. That includes the cursor position. Typed keys are sent to the job.
The terminal contents can change at any time. This is called Terminal-Job
@@ -301,7 +301,9 @@ suspended. CTRL-\ CTRL-N does the same.
Terminal-Job mode is where |:tmap| mappings are applied. Keys sent by
|term_sendkeys()| are not subject to tmap, but keys from |feedkeys()| are.

It is not possible to enter Insert mode from Terminal-Job mode.

*Terminal-Normal* *E946*
In Terminal-Normal mode you can move the cursor around with the usual Vim
commands, Visually mark text, yank text, etc. But you cannot change the
contents of the buffer. The commands that would start insert mode, such as
@@ -312,7 +314,10 @@ In Terminal-Normal mode the statusline and window title show "(Terminal)". If
the job ends while in Terminal-Normal mode this changes to

It is not possible to enter Insert mode from Terminal-Job mode.
When the job outputs lines in the terminal, such that the contents scrolls off
the top, those lines are remembered and can be seen in Terminal-Normal mode.
The number of lines is limited by the 'terminalscroll' option. When going over
this limit, the first 10% of the scrolled lins are deleted and are lost.

Cursor style ~
@@ -2748,6 +2748,15 @@ static struct vimoption options[] =
(char_u*)NULL, PV_NONE,
{(char_u *)FALSE, (char_u *)FALSE}
{"terminalscroll", "tlsl", P_NUM|P_VI_DEF|P_VIM|P_RBUF,
(char_u *)&p_tlsl, PV_NONE,
{(char_u *)10000L, (char_u *)10000L}
(char_u *)NULL, PV_NONE,
{(char_u *)NULL, (char_u *)0L}
{"termkey", "tk", P_STRING|P_ALLOCED|P_RWIN|P_VI_DEF,
@@ -849,6 +849,9 @@ EXTERN char_u *p_tcldll; /* 'tcldll' */
EXTERN int p_tbidi; /* 'termbidi' */
EXTERN long p_tlsl; /* 'terminalscroll' */
EXTERN char_u *p_tenc; /* 'termencoding' */
@@ -40,8 +40,6 @@
* - Win32: Make terminal used for :!cmd in the GUI work better. Allow for
* redirection. Probably in call to channel_set_pipes().
* - add an optional limit for the scrollback size. When reaching it remove
* 10% at the start.
* - Copy text in the vterm to the Vim buffer once in a while, so that
* completion works.
* - in GUI vertical split causes problems. Cursor is flickering. (Hirohito
@@ -2518,7 +2516,27 @@ handle_pushline(int cols, const VTermScreenCell *cells, void *user)
term_T *term = (term_T *)user;

/* TODO: Limit the number of lines that are stored. */
/* If the number of lines that are stored goes over 'termscrollback' then
* delete the first 10%. */
if (term->tl_scrollback.ga_len > p_tlsl)
int todo = p_tlsl / 10;
int i;

curbuf = term->tl_buffer;
for (i = 0; i < todo; ++i)
vim_free(((sb_line_T *)term->tl_scrollback.ga_data + i)->sb_cells);
ml_delete(1, FALSE);
curbuf = curwin->w_buffer;

term->tl_scrollback.ga_len -= todo;
(sb_line_T *)term->tl_scrollback.ga_data + todo,
sizeof(sb_line_T) * term->tl_scrollback.ga_len);

if (ga_grow(&term->tl_scrollback, 1) == OK)
cellattr_T *p = NULL;
@@ -762,6 +762,8 @@ static char *(features[]) =

static int included_patches[] =
{ /* Add new patch number below this line */

0 comments on commit 8c041b6

Please sign in to comment.