| Revision | f6ec862d7594e29ae80a6e49f66ad4c76cf09abc (tree) |
|---|---|
| Time | 2015-12-28 07:40:35 |
| Author | divVerent <divVerent@xono...> |
| Commiter | divVerent |
Merge pull request #9 from Mailaender/man
Added man pages for tools
Makefile.am (diff) s2tc_compress.1 (diff) s2tc_decompress.1 (diff) s2tc_from_s3tc.1 (diff)| @@ -9,6 +9,7 @@ bin_PROGRAMS = s2tc_compress s2tc_decompress s2tc_from_s3tc | ||
| 9 | 9 | s2tc_from_s3tc_SOURCES = s2tc_from_s3tc.cpp s2tc_license.h |
| 10 | 10 | s2tc_compress_SOURCES = s2tc_compress.c txc_dxtn.h s2tc_license.h |
| 11 | 11 | s2tc_decompress_SOURCES = s2tc_decompress.c txc_dxtn.h s2tc_license.h |
| 12 | +man1_MANS = s2tc_compress.1 s2tc_decompress.1 s2tc_from_s3tc.1 | |
| 12 | 13 | if ENABLE_RUNTIME_LINKING |
| 13 | 14 | s2tc_compress_LDADD = $(LIBDL_LDADD) |
| 14 | 15 | s2tc_decompress_LDADD = $(LIBDL_LDADD) |
| @@ -0,0 +1,37 @@ | ||
| 1 | +.TH S2TC_COMPRESS 1 "December 26, 2015" | |
| 2 | +.\" Please adjust this date whenever revising the manpage. | |
| 3 | +.SH NAME | |
| 4 | +s2tc_compress \- Compress the image into a S2TC format texture. | |
| 5 | +.SH SYNOPSIS | |
| 6 | +\fBs2tc_compress\fP | |
| 7 | +.SH DESCRIPTION | |
| 8 | +s2tc_compress allows compression of images into S2TC format textures. | |
| 9 | +.SH OPTIONS | |
| 10 | +.TP | |
| 11 | +.BI -i | |
| 12 | +\fIINFILE.tga\fP | |
| 13 | +.TP | |
| 14 | +.BI -o | |
| 15 | +\fIOUTFILE.dds\fP | |
| 16 | +.TP | |
| 17 | +.BI -t | |
| 18 | +One of the following compression algorithms | |
| 19 | +.RS | |
| 20 | +.BI DXT1 | |
| 21 | + | |
| 22 | +.BI DXT3 | |
| 23 | + | |
| 24 | +.BI DXT5 | |
| 25 | + | |
| 26 | +.RE | |
| 27 | +.TP | |
| 28 | +.BI -l | |
| 29 | +\fIlibtxc_dxtn.so\fP | |
| 30 | +Path to an implementation of libtxc-dxtn | |
| 31 | +.TP | |
| 32 | + | |
| 33 | +.SH AUTHOR | |
| 34 | +s2tc_compress is part of the S2TC toolset | |
| 35 | +.PP | |
| 36 | +This manual page was written by Lennart Weller <lhw@ring0.de>, | |
| 37 | +for the Debian project (but may be used by others). |
| @@ -0,0 +1,27 @@ | ||
| 1 | +.TH S2TC_DECOMPRESS 1 "December 26, 2015" | |
| 2 | +.\" Please adjust this date whenever revising the manpage. | |
| 3 | +.SH NAME | |
| 4 | +s2tc_decompress \- Decompresses the texture into an image | |
| 5 | +.SH SYNOPSIS | |
| 6 | +\fBs2tc_decompress\fP | |
| 7 | +.SH DESCRIPTION | |
| 8 | +s2tc_decompress allows decompression of S2TC format textures | |
| 9 | +into TGA images. | |
| 10 | +.SH OPTIONS | |
| 11 | +.TP | |
| 12 | +.BI -i | |
| 13 | +\fIINFILE.dds\fP | |
| 14 | +.TP | |
| 15 | +.BI -o | |
| 16 | +\fIOUTFILE.tga\fP | |
| 17 | +.TP | |
| 18 | +.BI -l | |
| 19 | +\fIlibtxc_dxtn.so\fP | |
| 20 | +Path to an implementation of libtxc-dxtn | |
| 21 | +.TP | |
| 22 | + | |
| 23 | +.SH AUTHOR | |
| 24 | +s2tc_decompress is part of the S2TC toolset | |
| 25 | +.PP | |
| 26 | +This manual page was written by Lennart Weller <lhw@ring0.de>, | |
| 27 | +for the Debian project (but may be used by others). |
| @@ -0,0 +1,27 @@ | ||
| 1 | +.TH S2TC_FROM_S3TC 1 "December 26, 2015" | |
| 2 | +.\" Please adjust this date whenever revising the manpage. | |
| 3 | +.SH NAME | |
| 4 | +s2tc_from_s3tc \- Convert a S3TC format texture into S2TC format one. | |
| 5 | +.SH SYNOPSIS | |
| 6 | +\fBs2tc_from_s3tc\fP | |
| 7 | +.SH DESCRIPTION | |
| 8 | +s2tc_from_s3tc allows a very simple conversion without any kind of | |
| 9 | +dithering conversion of S3TC format textures into S2TC format ones | |
| 10 | +using the lossy algorithm implemented in S2TC. | |
| 11 | + | |
| 12 | +It is faster but yields lower quality than decompressing using a | |
| 13 | +s3tc tool and also even worse than s2tc_decompress. | |
| 14 | +.SH OPTIONS | |
| 15 | +.TP | |
| 16 | +.BI -i | |
| 17 | +\fIINFILE.dds\fP | |
| 18 | +.TP | |
| 19 | +.BI -o | |
| 20 | +\fIOUTFILE.dds\fP | |
| 21 | +.TP | |
| 22 | + | |
| 23 | +.SH AUTHOR | |
| 24 | +s2tc_from_s3tc is part of the S2TC toolset | |
| 25 | +.PP | |
| 26 | +This manual page was written by Lennart Weller <lhw@ring0.de>, | |
| 27 | +for the Debian project (but may be used by others). |
Android-x86
Fork