scroll

commit 7e1f280882a96995f7f26e4693aa83632ca8ed97
parent 31c039eec4500cc05fbf9787d1dbcd13b6c8910c
Author: Jan Klemkow <j.klemkow@wemelug.de>
Date:   Mon, 10 Feb 2020 17:54:54 +0100

add manpage

Diffstat:
M
Makefile
 | 
1
+
M
config.mk
 | 
2
++
A
scroll.1
 | 
49
+++++++++++++++++++++++++++++++++++++++++++++++++

3 files changed, 52 insertions(+), 0 deletions(-)
diff --git a/Makefile b/Makefile
@@ -8,6 +8,7 @@ clean:
 
 install: scroll
 	cp scroll ${BINDIR}
+	cp scroll.1 ${MAN1DIR}
 
 test: scroll
 	# check usage
diff --git a/config.mk b/config.mk
@@ -1,6 +1,8 @@
 # paths
 PREFIX	= /usr/local
 BINDIR	= ${PREFIX}/bin
+MANDIR	= ${PREFIX}/share/man
+MAN1DIR	= ${MANDIR}/man1
 
 CC ?= cc
 CFLAGS = -std=c99 -pedantic -Wall -Wextra -g
diff --git a/scroll.1 b/scroll.1
@@ -0,0 +1,49 @@
+.\"
+.\" Copyright (c) 2020 Jan Klemkow <j.klemkow@wemelug.de>
+.\"
+.\" Permission to use, copy, modify, and distribute this software for any
+.\" purpose with or without fee is hereby granted, provided that the above
+.\" copyright notice and this permission notice appear in all copies.
+.\"
+.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER 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$
+.Dt SCROLL 1
+.Os
+.Sh NAME
+.Nm scroll
+.Nd scrollback buffer
+.Sh SYNOPSIS
+.Nm
+.Ar program
+.Sh DESCRIPTION
+The
+.Nm
+utility saves output lines from the child
+.Ar program
+to use them for scrollback.
+.Sh EXIT STATUS
+.Nm
+exits with the status code of its the child
+.Ar program .
+.Sh EXAMPLES
+.Nm st
+.Fl e
+.Nm scroll
+.Nm /bin/sh
+.Sh SEE ALSO
+.Xr screen 1 ,
+.Xr st 1 ,
+.Xr tmux 1
+.Sh AUTHORS
+.Nm
+was written by
+.An Jan Klemkow Aq Mt j.klemkow@wemelug.de
+and
+.An Jochen Sprickerhof Aq Mt git@jochen.sprickerhof.de .