114 lines
1.9 KiB
Groff
114 lines
1.9 KiB
Groff
.TH "ktx" 1 "Sun Jun 14 2026 18:00:57" "Version 0.0.0" "KTX Tools Reference" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
ktx \- Unified CLI frontend for the KTX-Software library\&.
|
|
.SH "SYNOPSIS"
|
|
.PP
|
|
ktx <command> [command-option\&.\&.\&.]
|
|
.br
|
|
ktx [option\&.\&.\&.]
|
|
.SH "DESCRIPTION"
|
|
.PP
|
|
Unified CLI frontend for the KTX-Software library with sub-commands for specific operations for the KTX File Format Specification https://registry.khronos.org/KTX/specs/2.0/ktxspec.v2.html\&.
|
|
|
|
.PP
|
|
The following commands are available:
|
|
|
|
.PP
|
|
.IP "\fB\fBcreate\fP
|
|
.IP "" 1c
|
|
Create a KTX2 file from various input files\&.
|
|
|
|
.PP
|
|
.IP "\fB\fBdeflate\fP
|
|
.IP "" 1c
|
|
Deflate (supercompress) a KTX2 file\&.
|
|
|
|
.PP
|
|
.IP "\fB\fBextract\fP
|
|
.IP "" 1c
|
|
Extract selected images from a KTX2 file\&.
|
|
|
|
.PP
|
|
.IP "\fB\fBencode\fP
|
|
.IP "" 1c
|
|
Encode a KTX2 file\&.
|
|
|
|
.PP
|
|
.IP "\fB\fBtranscode\fP
|
|
.IP "" 1c
|
|
Transcode a KTX2 file\&.
|
|
|
|
.PP
|
|
.IP "\fB\fBinfo\fP
|
|
.IP "" 1c
|
|
Print information about a KTX2 file\&.
|
|
|
|
.PP
|
|
.IP "\fB\fBvalidate\fP
|
|
.IP "" 1c
|
|
Validate a KTX2 file\&.
|
|
|
|
.PP
|
|
.IP "\fB\fBcompare\fP
|
|
.IP "" 1c
|
|
Compare two KTX2 files\&.
|
|
|
|
.PP
|
|
.IP "\fB\fBhelp\fP
|
|
.IP "" 1c
|
|
Display help information about the ktx tool\&.
|
|
|
|
.PP
|
|
.SH "OPTIONS"
|
|
.PP
|
|
The following options are also available without a command:
|
|
|
|
.PP
|
|
.IP "\fB-h, --help
|
|
.IP "" 1c
|
|
Print this usage message and exit\&.
|
|
|
|
.PP
|
|
.IP "\fB-v, --version
|
|
.IP "" 1c
|
|
Print the version number of this program and exit\&.
|
|
|
|
.PP
|
|
.SH "EXIT STATUS"
|
|
.PP
|
|
.IP "\(bu" 2
|
|
0 - Success
|
|
.IP "\(bu" 2
|
|
1 - Command line error
|
|
.IP "\(bu" 2
|
|
2 - IO failure
|
|
.IP "\(bu" 2
|
|
3 - Invalid input file
|
|
.IP "\(bu" 2
|
|
4 - Runtime or library error
|
|
.IP "\(bu" 2
|
|
5 - Not supported state or operation
|
|
.IP "\(bu" 2
|
|
6 - Requested feature is not yet implemented
|
|
.PP
|
|
.SH "HISTORY"
|
|
.PP
|
|
\fBVersion 4\&.0\fP
|
|
.RS 4
|
|
|
|
.IP "\(bu" 2
|
|
Initial version
|
|
.PP
|
|
.RE
|
|
.PP
|
|
.SH "AUTHOR"
|
|
.PP
|
|
.IP "\(bu" 2
|
|
Mátyás Császár [Vader], RasterGrid www\&.rastergrid\&.com
|
|
.IP "\(bu" 2
|
|
Daniel Rákos, RasterGrid www\&.rastergrid\&.com
|
|
.PP
|
|
|