scroll

scrollbackbuffer program for st
git clone git://git.suckless.org/scroll
Log | Files | Refs | README | LICENSE

scroll.1 (1655B)


      1 .\"
      2 .\" Copyright (c) 2020 Jan Klemkow <j.klemkow@wemelug.de>
      3 .\"
      4 .\" Permission to use, copy, modify, and distribute this software for any
      5 .\" purpose with or without fee is hereby granted, provided that the above
      6 .\" copyright notice and this permission notice appear in all copies.
      7 .\"
      8 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
      9 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
     10 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
     11 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
     12 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
     13 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
     14 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
     15 .\"
     16 .Dd April 9, 2020
     17 .Dt SCROLL 1
     18 .Os
     19 .Sh NAME
     20 .Nm scroll
     21 .Nd scrollback buffer
     22 .Sh SYNOPSIS
     23 .Nm
     24 .Op Fl Mh
     25 .Op Fl m Ar size
     26 .Op program Op arg ...
     27 .Sh DESCRIPTION
     28 The
     29 .Nm
     30 utility saves output lines from the child
     31 .Ar program
     32 to use them for scrollback.
     33 If
     34 .Ar program
     35 is not set,
     36 .Nm
     37 starts the users default shell.
     38 .Pp
     39 The options are as follows:
     40 .Bl -tag -width Ds
     41 .It Fl h
     42 Shows usage of
     43 .Nm .
     44 .It Fl M
     45 Set memory limit used for scrollbackbuffer to maximum.
     46 .It Fl m Ar size
     47 Set memory limit used for scrollbackbuffer to
     48 .Ar size .
     49 .El
     50 .Sh EXIT STATUS
     51 .Nm
     52 exits with the status code of its the child
     53 .Ar program .
     54 .Sh EXAMPLES
     55 .Nm st
     56 .Fl e
     57 .Nm scroll
     58 .Nm /bin/sh
     59 .Sh SEE ALSO
     60 .Xr screen 1 ,
     61 .Xr st 1 ,
     62 .Xr tmux 1
     63 .Sh AUTHORS
     64 .Nm
     65 was written by
     66 .An Jan Klemkow Aq Mt j.klemkow@wemelug.de
     67 and
     68 .An Jochen Sprickerhof Aq Mt git@jochen.sprickerhof.de .