ktx_info(1)

🦋 ktx_info(1) 🦋

Hiii bestie, welcome to the KTX Tools Reference page for ktx_info — the little tool that spills all the tea about your KTX files. ☕✨

🌸 NAME 🌸

ktx_info — ktx info. Prints information about a KTX2 file.

✨ SYNOPSIS ✨

ktx info [option...] input-file

💖 DESCRIPTION 💖

ktx info prints the info about the KTX v1 or v2 file you pass as the input-file argument. If input-file is '-', the file gets read from stdin. No cap. 🫶

For KTX v2 files, the command implicitly calls validate and prints any errors and warnings it finds to stdout. If the file is invalid, the info is shown on a best-effort basis and may be incomplete — like, it’s doing its absolute best with what it has. 😭

The JSON output formats conform to the https://schema.khronos.org/ktx/info_v0.json schema even if the input file is invalid and certain information cannot be parsed or displayed. Also, for JSON outputs the KTX file identifier is printed using "\u001A" instead of "\x1A" — because an unescaped "\x1A" sequence inside a JSON string breaks nearly every JSON tool. Bestie, that’s not a vibe. 💀 Note that this does not change the value of the string, only its representation. JSON output is only supported for KTX v2 files. If you request it for a KTX v1 file, an error is generated.

📝 Note

ktx info prints using UTF-8 encoding. If your console is not set for UTF-8, you will see incorrect characters in the output of the file identifier on each side of the "KTX nn". So like… check your console setup before side-eyeing the output. 🙈

🎀 OPTIONS 🎀

The following options are available:

• --format text | json | mini-json — Specifies the report output format. The possible options are:
  • text — Human readable text based format.
  • json — Formatted JSON.
  • mini-json — Minified JSON. The default format is text.
• -h, --help — Print this usage message and exit.
• -v, --version — Print the version number of this program and exit.

🌈 EXIT STATUS 🌈

• 0 — Success
• 1 — Command line error
• 2 — IO failure
• 3 — Invalid input file
• 4 — Runtime or library error
• 5 — Not supported state or operation
• 6 — Requested feature is not yet implemented

🦋 HISTORY 🦋

Version 4.0

• Initial version

👑 AUTHOR 👑

• Mátyás Császár [Vader], RasterGrid www.rastergrid.com
• Daniel Rákos, RasterGrid www.rastergrid.com

---

Catch you later, bestie — this page is serving Version 0.0.0, dated Tue Jan 1 1980 00:00:00. Byeee 💅