Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #9 from Mailaender/man
Added man pages for tools
- Loading branch information
Showing
4 changed files
with
92 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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). |