Add a manpage. - vtv-tools - virtual terminal video tools
DIR Log
DIR Files
DIR Refs
DIR Tags
DIR README
DIR LICENSE
---
DIR commit 02e71d857c5dc511e66c79877d77658e379243ab
DIR parent f5b55df3afafc5924c639a59699e3fb9488dd29e
HTML Author: Troels Henriksen <athas@sigkill.dk>
Date: Mon, 14 Aug 2023 21:02:43 +0200
Add a manpage.
Diffstat:
M Makefile | 5 +++++
A man/vtv-from-ff.1 | 34 +++++++++++++++++++++++++++++++
2 files changed, 39 insertions(+), 0 deletions(-)
---
DIR diff --git a/Makefile b/Makefile
@@ -1,4 +1,5 @@
PREFIX ?= /usr/local
+MANPREFIX ?= ${PREFIX}/share/man
CFLAGS?=-O -Wall -Wextra -pedantic
CC?=cc
@@ -12,5 +13,9 @@ install: all
@echo \# Installing executable files to ${PREFIX}/bin
@mkdir -p ${PREFIX}/bin/
install bin/* ${PREFIX}/bin/
+ @echo \# Installing manual page to ${MANPREFIX}/man1
+ @mkdir -p ${MANPREFIX}/man1/
+ @echo \# Installing manpages to ${MANPREFIX}/man1/
+ install -D -m 644 man/* ${MANPREFIX}/man1/
.PHONY: all install
DIR diff --git a/man/vtv-from-ff.1 b/man/vtv-from-ff.1
@@ -0,0 +1,34 @@
+.Dd August 14, 2023
+.Dt VTV-FROM-FF 1
+.OS
+.
+.sh NAME
+.Nm vtv-from-ff
+.Nd convert farbfeld to vtv
+.
+.Sh SYNOPSIS
+.Nm
+.Bk
+.Op Ar FILE ...
+.Ek
+.
+.Sh DESCRIPTION
+.Bd -filled
+.Nm
+is a tool for converting farbfeld to vtv. Each farbfeld image is
+converted to a single-frame .vtv file. As farbfeld use a 16-bit colour
+channel while vtv uses only 8 bits, only the most significant 8 bits
+are considered.
+.
+If passed no arguments,
+.Nm
+will read a farbfeld image from stdin and produce a vtv on stdout.
+Otherwise, the arguments must be filenames the form "foo.ff", each of
+which will be converted to a corresponding "foo.vtv".
+.
+If you wish to play the produced .vtv files in
+.Xr vtv-player 1
+then the images should all be 73x25 pixels in size.
+.
+.Sh LICENSE
+The vtv-tools are released under the GPLv3 or later.