EPUBCHECK(1)

💖 epubcheck(1) 💖

epubcheck — the validation tool for EPUB, bestie. She's a User Commands girlie, she lives in your terminal, and she is here to read your .epub for filth (lovingly) 💅

---

✨ NAME ✨

epubcheck — validation tool for EPUB 🦋

---

✨ SYNOPSIS ✨

epubcheck file.epub

that's it. that's the whole vibe. one file, one command, no cap 🌸

---

🌸 DESCRIPTION 🌸

Okay so here's the tea: all detected errors are simply printed to stderr. Every single one. She's not subtle and she's not sorry 💀

This is EPUBCheck v4.1.0, periodt.

When you run this tool, the first argument should be the name (with the path!) of the file you want to check. Don't forget the path, bestie, she's not psychic 🙈

---

🎀 Validation profiles 🎀

Wanna run checks against a specific EPUB 3 profile or extension specification? Slay. Just use the -profile option:

Validation profiles supported:

• --profile default — the default validation profile
• --profile dict — validates against the EPUB Dictionaries and Glossaries specification
• --profile edupub — validates against the EDUPUB Profile
• --profile idx — validates against the EPUB Indexes specification
• --profile preview — validates against the EPUB Previews specification

---

🦋 Non-epub files, modes & versions 🦋

If you're checking a non-epub file, you must specify the epub version of the file using -v, and the type of the file using -mode. The default version is: 3.0.

Modes and versions supported:

• --mode opf -v 2.0
• --mode opf -v 3.0
• --mode xhtml -v 2.0
• --mode xhtml -v 3.0
• --mode svg -v 2.0
• --mode svg -v 3.0
• --mode nav -v 3.0
• --mode mo -v 3.0 — for Media Overlays validation
• --mode exp — for expanded EPUB archives

---

💅 OPTIONS 💅

This tool also accepts the following options, and yes we're listing every last one of them, because we don't skip content in this house 👑

• --save — saves the epub created from the expanded epub
• --out <file> — output an assessment XML document file (use - to output to console)
• --xmp <file> — output an assessment XMP document file (use - to output to console)
• --json <file> — output an assessment JSON document file (use - to output to console)
• -m <file> — same as --mode
• -p <profile> — same as --profile
• -o <file> — same as --out
• -x <file> — same as --xmp
• -j <file> — same as --json
• --failonwarnings[+|-] — By default, the tool returns a 1 if errors are found in the file or 0 if no errors are found. Using --failonwarnings will cause the process to exit with a status of
  • 1 if either warnings or errors are present, and 0 only when there are no errors or warnings.
• -q, --quiet — no message on console, except errors, only in the output
• -f, --fatal — include only fatal errors in the output
• -e, --error — include only error and fatal severity messages in output
• -w, --warn — include fatal, error, and warn severity messages in output
• -u, --usage — include ePub feature usage information in output (default is OFF); if enabled, usage information will always be included in the output file
• --locale <locale> — output localized messages according to the provided IETF BCP 47 language tag string
• -l, --listChecks [<file>] — list message ids and severity levels to the custom message file named <file>, or the console
• -c, --customMessages [<file>] — override message severity levels as defined in the custom message file named <file>
• --version — displays the EPUBCheck version
• -h, -? or --help — displays this help message

and then, when she's done cooking, she says: epubcheck completed — the little mic drop at the end, iconic 🔥

---

👑 AUTHOR 👑

Shoutout to the whole squad who built her:

• Peter Sorotokin
• Garth Conboy
• Markus Gylling
• Piotr Kula
• Paul Norton
• Jessica Hekman
• George Bina
• Bogdan Iordache
• Ionut-Maxim Margelatu
• Romain Deltour

Most of the EpubCheck functionality comes from the schema validation tool Jing and schemas that were developed by IDPF and DAISY. Initial EpubCheck development was largely done at Adobe Systems. the lore is real 📚✨

This manual page was written by Mathieu Malaterre <malat@debian.org> for the Debian GNU/Linux system, but may be used by others. king behavior, honestly 🫶

---

and that's the whole page, bestie — epubcheck 4.2.4, September 2020, EPUBCHECK(1) 💖✨🎀🦋 go validate something and have the best day fr fr 💅🌸