Add an option (scroll-on-clear) to control if tmux scrolls into history

on clear, from Robert Lange in GitHub issue 3121.

diff --git a/usr.bin/tmux/options-table.c b/usr.bin/tmux/options-table.c
index 224e097..bc8b56a 100644 (file)
--- a/usr.bin/tmux/options-table.c
+++ b/usr.bin/tmux/options-table.c
@@ -1,4 +1,4 @@
-/* $OpenBSD: options-table.c,v 1.160 2022/03/16 17:00:17 nicm Exp $ */
+/* $OpenBSD: options-table.c,v 1.161 2022/03/17 11:35:37 nicm Exp $ */
 
 /*
  * Copyright (c) 2011 Nicholas Marriott <nicholas.marriott@gmail.com>
@@ -1081,6 +1081,14 @@ const struct options_table_entry options_table[] = {
                  "remain-on-exit is enabled."
        },
 
+       { .name = "scroll-on-clear",
+         .type = OPTIONS_TABLE_FLAG,
+         .scope = OPTIONS_TABLE_WINDOW|OPTIONS_TABLE_PANE,
+         .default_num = 1,
+         .text = "Whether the contents of the screen should be scrolled into"
+                 "history when clearing the whole screen."
+       },
+
        { .name = "synchronize-panes",
          .type = OPTIONS_TABLE_FLAG,
          .scope = OPTIONS_TABLE_WINDOW|OPTIONS_TABLE_PANE,

diff --git a/usr.bin/tmux/screen-write.c b/usr.bin/tmux/screen-write.c
index 6af8fb5..367759d 100644 (file)
--- a/usr.bin/tmux/screen-write.c
+++ b/usr.bin/tmux/screen-write.c
@@ -1,4 +1,4 @@
-/* $OpenBSD: screen-write.c,v 1.205 2021/10/26 12:22:23 nicm Exp $ */
+/* $OpenBSD: screen-write.c,v 1.206 2022/03/17 11:35:37 nicm Exp $ */
 
 /*
  * Copyright (c) 2007 Nicholas Marriott <nicholas.marriott@gmail.com>
@@ -1427,7 +1427,11 @@ screen_write_clearendofscreen(struct screen_write_ctx *ctx, u_int bg)
        ttyctx.bg = bg;
 
        /* Scroll into history if it is enabled and clearing entire screen. */
-       if (s->cx == 0 && s->cy == 0 && (gd->flags & GRID_HISTORY))
+       if (s->cx == 0 &&
+           s->cy == 0 &&
+           (gd->flags & GRID_HISTORY) &&
+           ctx->wp != NULL &&
+           options_get_number(ctx->wp->options, "scroll-on-clear"))
                grid_view_clear_history(gd, bg);
        else {
                if (s->cx <= sx - 1)

diff --git a/usr.bin/tmux/tmux.1 b/usr.bin/tmux/tmux.1
index 9702443..5a2a50e 100644 (file)
--- a/usr.bin/tmux/tmux.1
+++ b/usr.bin/tmux/tmux.1
@@ -1,4 +1,4 @@
-.\" $OpenBSD: tmux.1,v 1.883 2022/03/16 17:00:17 nicm Exp $
+.\" $OpenBSD: tmux.1,v 1.884 2022/03/17 11:35:37 nicm Exp $
 .\"
 .\" Copyright (c) 2007 Nicholas Marriott <nicholas.marriott@gmail.com>
 .\"
@@ -14,7 +14,7 @@
 .\" IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
 .\" OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 .\"
-.Dd $Mdocdate: March 16 2022 $
+.Dd $Mdocdate: March 17 2022 $
 .Dt TMUX 1
 .Os
 .Sh NAME
@@ -4476,6 +4476,12 @@ Set the text shown at the bottom of exited panes when
 .Ic remain-on-exit
 is enabled.
 .Pp
+.It Xo Ic scroll-on-clear
+.Op Ic on | off
+.Xc
+When the entire screen is cleared and this option is on, scroll the contents of
+the screen into history before clearing it.
+.Pp
 .It Xo Ic synchronize-panes
 .Op Ic on | off
 .Xc