diff options
-rw-r--r-- | share/man/man1/ovr.1 | 80 |
1 files changed, 80 insertions, 0 deletions
diff --git a/share/man/man1/ovr.1 b/share/man/man1/ovr.1 new file mode 100644 index 0000000..c9641f5 --- /dev/null +++ b/share/man/man1/ovr.1 @@ -0,0 +1,80 @@ +.\" SPDX_FileCopyrightText: 2023, Alejandro Colomar <alx@kernel.org> +.\" SPDX-License-Identifier: GPL-3.0-or-later +.TH ovr 1 2023-10-10 ovr +. +. +.SH Name +ovr +\- +stdout lines overwrite each other +. +. +.SH Synopsis +.SY ovr +.RI [ option\~ .\|.\|.] +. +. +.SH Options +.TP +.BI \-n " lines" +.TQ +.BI \-\-lines " lines" +Set the number of lines that should remain in the terminal +after the program ends. +Default is 1. +. +. +.SH Description +This program uses the alternate screen +(see +.MR terminfo 5 ) +so that the output of a program doesn't pollute the terminal. +.PP +It is useful for example when compiling software, +as most of the time we're only interested +in the progress and the final result +and a complete and permanent history of the build is unnecessary. +.PP +At the end of the program, +it prints the last lines (see Options: \-n) +on the terminal, +as +.IR "tail -n lines" . +. +.SS Signals +.B SIGINT +is ignored by the program. +This allows interrupting a pipeline +without disrupting the alternate screen. +. +. +.SH Examples +Building the Linux kernel. +.PP +.EX +.RB $ " make \-j24 | ovr \-n 4; echo $?" +\& BTF [M] net/qrtr/qrtr.ko +\& BTF [M] virt/lib/irqbypass.ko +\& BTF [M] net/hsr/hsr.ko +\& BTF [M] net/qrtr/qrtr\-mhi.ko +0 +.EE +. +. +.SH Reporting bugs +.TP +Git +.UR https://www.alejandro-colomar.es/\:src/\:alx/\:alx/\:utils/\:ovr.git +.UE +.TP +Maintainer +.MT alx@kernel.org +Alejandro Colomar +.ME +. +. +.SH See also +.MR tput 1 , +.MR less 1 , +.MR tail 1 , +.MR terminfo 5 |