scroll.1 1.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960
  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 $Mdocdate$
  17. .Dt SCROLL 1
  18. .Os
  19. .Sh NAME
  20. .Nm scroll
  21. .Nd scrollback buffer
  22. .Sh SYNOPSIS
  23. .Nm
  24. .Op Fl M
  25. .Op Fl m Ar size
  26. .Ar program
  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. .Pp
  34. The options are as follows:
  35. .Bl -tag -width Ds
  36. .It Fl M
  37. Set memory limit used for scrollbackbuffer to maximum.
  38. .It Fl m Ar size
  39. Set memory limit used for scrollbackbuffer to
  40. .Ar size .
  41. .El
  42. .Sh EXIT STATUS
  43. .Nm
  44. exits with the status code of its the child
  45. .Ar program .
  46. .Sh EXAMPLES
  47. .Nm st
  48. .Fl e
  49. .Nm scroll
  50. .Nm /bin/sh
  51. .Sh SEE ALSO
  52. .Xr screen 1 ,
  53. .Xr st 1 ,
  54. .Xr tmux 1
  55. .Sh AUTHORS
  56. .Nm
  57. was written by
  58. .An Jan Klemkow Aq Mt j.klemkow@wemelug.de
  59. and
  60. .An Jochen Sprickerhof Aq Mt git@jochen.sprickerhof.de .