From a259213480afc56b743ef5a7b933dee35b3cd205 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Matthias=20Mail=C3=A4nder?= <matthias@mailaender.name>
Date: Sun, 20 Dec 2015 14:18:09 +0100
Subject: [PATCH] add man pages for tools

---
 Makefile.am       |  1 +
 s2tc_compress.1   | 37 +++++++++++++++++++++++++++++++++++++
 s2tc_decompress.1 | 27 +++++++++++++++++++++++++++
 s2tc_from_s3tc.1  | 27 +++++++++++++++++++++++++++
 4 files changed, 92 insertions(+)
 create mode 100644 s2tc_compress.1
 create mode 100644 s2tc_decompress.1
 create mode 100644 s2tc_from_s3tc.1

diff --git a/Makefile.am b/Makefile.am
index 538831e..02df825 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -9,6 +9,7 @@ bin_PROGRAMS = s2tc_compress s2tc_decompress s2tc_from_s3tc
 s2tc_from_s3tc_SOURCES = s2tc_from_s3tc.cpp s2tc_license.h
 s2tc_compress_SOURCES = s2tc_compress.c txc_dxtn.h s2tc_license.h
 s2tc_decompress_SOURCES = s2tc_decompress.c txc_dxtn.h s2tc_license.h
+man1_MANS = s2tc_compress.1 s2tc_decompress.1 s2tc_from_s3tc.1
 if ENABLE_RUNTIME_LINKING
 s2tc_compress_LDADD = $(LIBDL_LDADD)
 s2tc_decompress_LDADD = $(LIBDL_LDADD)
diff --git a/s2tc_compress.1 b/s2tc_compress.1
new file mode 100644
index 0000000..7f76e51
--- /dev/null
+++ b/s2tc_compress.1
@@ -0,0 +1,37 @@
+.TH S2TC_COMPRESS 1 "December 26, 2015"
+.\" Please adjust this date whenever revising the manpage.
+.SH NAME
+s2tc_compress \- Compress the image into a S2TC format texture.
+.SH SYNOPSIS
+\fBs2tc_compress\fP
+.SH DESCRIPTION
+s2tc_compress allows compression of images into S2TC format textures.
+.SH OPTIONS
+.TP
+.BI -i
+\fIINFILE.tga\fP
+.TP
+.BI -o
+\fIOUTFILE.dds\fP
+.TP
+.BI -t
+One of the following compression algorithms
+.RS
+.BI DXT1
+
+.BI DXT3
+
+.BI DXT5
+
+.RE
+.TP
+.BI -l
+\fIlibtxc_dxtn.so\fP
+Path to an implementation of libtxc-dxtn
+.TP
+
+.SH AUTHOR
+s2tc_compress is part of the S2TC toolset
+.PP
+This manual page was written by Lennart Weller <lhw@ring0.de>,
+for the Debian project (but may be used by others).
diff --git a/s2tc_decompress.1 b/s2tc_decompress.1
new file mode 100644
index 0000000..873781e
--- /dev/null
+++ b/s2tc_decompress.1
@@ -0,0 +1,27 @@
+.TH S2TC_DECOMPRESS 1 "December 26, 2015"
+.\" Please adjust this date whenever revising the manpage.
+.SH NAME
+s2tc_decompress \- Decompresses the texture into an image
+.SH SYNOPSIS
+\fBs2tc_decompress\fP
+.SH DESCRIPTION
+s2tc_decompress allows decompression of S2TC format textures
+into TGA images.
+.SH OPTIONS
+.TP
+.BI -i
+\fIINFILE.dds\fP
+.TP
+.BI -o
+\fIOUTFILE.tga\fP
+.TP
+.BI -l
+\fIlibtxc_dxtn.so\fP
+Path to an implementation of libtxc-dxtn
+.TP
+
+.SH AUTHOR
+s2tc_decompress is part of the S2TC toolset
+.PP
+This manual page was written by Lennart Weller <lhw@ring0.de>,
+for the Debian project (but may be used by others).
diff --git a/s2tc_from_s3tc.1 b/s2tc_from_s3tc.1
new file mode 100644
index 0000000..14867c6
--- /dev/null
+++ b/s2tc_from_s3tc.1
@@ -0,0 +1,27 @@
+.TH S2TC_FROM_S3TC 1 "December 26, 2015"
+.\" Please adjust this date whenever revising the manpage.
+.SH NAME
+s2tc_from_s3tc \- Convert a S3TC format texture into S2TC format one.
+.SH SYNOPSIS
+\fBs2tc_from_s3tc\fP
+.SH DESCRIPTION
+s2tc_from_s3tc allows a very simple conversion without any kind of
+dithering conversion of S3TC format textures into S2TC format ones
+using the lossy algorithm implemented in S2TC.
+
+It is faster but yields lower quality than decompressing using a
+s3tc tool and also even worse than s2tc_decompress.
+.SH OPTIONS
+.TP
+.BI -i
+\fIINFILE.dds\fP
+.TP
+.BI -o
+\fIOUTFILE.dds\fP
+.TP
+
+.SH AUTHOR
+s2tc_from_s3tc is part of the S2TC toolset
+.PP
+This manual page was written by Lennart Weller <lhw@ring0.de>,
+for the Debian project (but may be used by others).