added manual page tcvt.1

2 files changed, 36 insertions, 3 deletions

diff --git a/Makefile b/Makefile
index abd6a79..c9e7755 100644
--- a/Makefile
+++ b/Makefile
@@ -1,14 +1,22 @@
 PREFIX ?= /usr/local
 BINDIR ?= ${PREFIX}/bin
+MANDIR ?= ${PREFIX}/share/man
 
-install:tcvt.py optcvt.sh.transformed
+install:build
+	install -d "${DESTDIR}${BINDIR}"
+	install -d "${DESTDIR}${MANDIR}/man1"
 	install -m755 tcvt.py "${DESTDIR}${BINDIR}/tcvt"
 	install -m755 optcvt.sh.transformed "${DESTDIR}${BINDIR}/optcvt"
-build:optcvt.sh.transformed
+	install -m644 tcvt.1.gz "${DESTDIR}${MANDIR}/man1/tcvt.1.gz"
+	ln -s tcvt.1.gz "${DESTDIR}${MANDIR}/man1/optcvt.1.gz"
+build:optcvt.sh.transformed tcvt.1.gz
 clean:
-	rm -f optcvt.sh.transformed
+	rm -f optcvt.sh.transformed tcvt.1.gz
 
 optcvt.sh.transformed:optcvt.sh
 	sed 's!^TCVT=.*!TCVT="${BINDIR}/tcvt"!' < $< > $@
 
+%.gz:%
+	gzip -9 < $< > $@
+
 .PHONY:build install clean
diff --git a/tcvt.1 b/tcvt.1
new file mode 100644
index 0000000..635f181
--- /dev/null
+++ b/tcvt.1
@@ -0,0 +1,25 @@
+.Dd Apr 15, 2012
+.Dt tcvt 1
+.Sh NAME
+tcvt - two column virtual terminal
+.Sh SYNOPSIS
+.nf
+\fBtcvt\fP \fIprogram options\fP
+.PP
+\fBoptcvt\fP \fIprogram options\fP
+.fi
+.Sh DESCRIPTION
+The two column virtual terminal emulates a virtual terminal inside another virtual terminal.
+The emulated virtual terminal is twice as tall and half as wide as the original terminal.
+The upper half of the virtual terminal goes to the left and the lower half goes to the right of the original terminal.
+An \fBANSI\fP terminal is emulated.
+Neither program takes any options.
+All arguments are forwarded to the called program.
+
+While \fBtcvt\fP splits does this conversion unconditionally, the \fBoptcvt\fP can be used with smaller terminals.
+It will only invoke \fBtcvt\fP, if the terminal is wide enough and otherwise simply exec the passed program.
+.Sh SEE ALSO
+.Xr screen 1
+.Xr splitvt 1
+.Sh AUTHOR
+Helmut Grohne <helmut@subdivi.de>