This commit is contained in:
2026-06-14 19:09:18 +01:00
parent 14bd1a9271
commit 13fa90a0e9
3958 changed files with 999286 additions and 4 deletions
+104
View File
@@ -0,0 +1,104 @@
.TH "ktx_help" 1 "Sun Jun 14 2026 18:00:57" "Version 0.0.0" "KTX Tools Reference" \" -*- nroff -*-
.ad l
.nh
.SH NAME
ktx_help \- ktx help
.PP
Display help information about the ktx tool\&.
.SH "SYNOPSIS"
.PP
ktx help [option\&.\&.\&.] [\fIcommand\fP]
.SH "DESCRIPTION"
.PP
\fBktx\fP \fBhelp\fP displays the man page of a specific ktx command specified as the \fIcommand\fP argument\&. On windows systems the man pages are opened with the system default browser in html format\&. On systems derived from Unix the man pages are opened with the man command\&.
.PP
To support custom install locations the tool first tries to use the man files relative to the executable and falls back to the system man pages\&.
.PP
\fIcommand\fP specifies which command's man page will be displayed\&. If \fIcommand\fP is s missing the main ktx tool man page will be displayed\&. Possible choices are:
.br
.IP "\(bu" 2
\fBcompare\fP
.br
.IP "\(bu" 2
\fBcreate\fP
.br
.IP "\(bu" 2
\fBdeflate\fP
.br
.IP "\(bu" 2
\fBencode\fP
.br
.IP "\(bu" 2
\fBextract\fP
.br
.IP "\(bu" 2
\fBinfo\fP
.br
.IP "\(bu" 2
\fBtranscode\fP
.br
.IP "\(bu" 2
\fBvalidate\fP
.br
.IP "\(bu" 2
\fBhelp\fP
.PP
.SH "OPTIONS"
.PP
.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