Files
how-to-vulkan/ktx/build/docs/man/man1/ktx2check.1
T
2026-06-14 19:09:18 +01:00

60 lines
1.3 KiB
Groff

.TH "ktx2check" 1 "Sun Jun 14 2026 18:00:57" "Version 0.0.0" "KTX Tools Reference" \" -*- nroff -*-
.ad l
.nh
.SH NAME
ktx2check \- Check the validity of a KTX 2 file\&.
.SH "SYNOPSIS"
.PP
ktx2check [options] [\fIinfile\fP \&.\&.\&.]
.SH "DESCRIPTION"
.PP
\fBktx2check\fP validates Khronos texture format version 2 files (KTX2)\&. It reads each named \fIinfile\fP and validates it writing to stdout messages about any issues found\&. When \fBinfile\fP is not specified, it validates a single file from stdin\&.
.PP
The following options are available:
.PP
.IP "\fB-q, --quiet
.IP "" 1c
Validate silently\&. Indicate valid or invalid via exit code\&.
.PP
.IP "\fB-m <num>, --max-issues <num>
.IP "" 1c
Set the maximum number of issues to be reported per file provided -q is not set\&.
.PP
.IP "\fB-w, --warn-as-error
.IP "" 1c
Treat warnings as errors\&. Changes exit code from success to error\&.
.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
\fBktx2check\fP exits 0 on success, 1 on command line errors and 2 on validation errors\&.
.SH "HISTORY"
.PP
\fBVersion 4\&.0\fP
.RS 4
.IP "\(bu" 2
Initial version\&.
.PP
.RE
.PP
.SH "AUTHOR"
.PP
Mark Callow, github\&.com/MarkCallow