.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.8. .TH EPUBCHECK "1" "September 2020" "epubcheck 4.2.4" "User Commands" .SH NAME epubcheck \- Validation tool for EPUB .SH SYNOPSIS epubcheck file.epub .SH DESCRIPTION All detected errors are simply printed to stderr .PP EPUBCheck v4.1.0 .PP When running this tool, the first argument should be the name (with the path) of the file to check. .PP To specify a validation profile (to run checks against a specific EPUB 3 profile or extension specification), use the \fB\-profile\fR option: .PP Validation profiles supported: \fB\-\-profile\fR default // the default validation profile \fB\-\-profile\fR dict // validates against the EPUB Dictionaries and Glossaries specification \fB\-\-profile\fR edupub // validates against the EDUPUB Profile \fB\-\-profile\fR idx // validates against the EPUB Indexes specification \fB\-\-profile\fR preview // validates against the EPUB Previews specification .PP If checking a non\-epub file, the epub version of the file must be specified using \fB\-v\fR and the type of the file using \fB\-mode\fR. The default version is: 3.0. .PP Modes and versions supported: \fB\-\-mode\fR opf \fB\-v\fR 2.0 \fB\-\-mode\fR opf \fB\-v\fR 3.0 \fB\-\-mode\fR xhtml \fB\-v\fR 2.0 \fB\-\-mode\fR xhtml \fB\-v\fR 3.0 \fB\-\-mode\fR svg \fB\-v\fR 2.0 \fB\-\-mode\fR svg \fB\-v\fR 3.0 \fB\-\-mode\fR nav \fB\-v\fR 3.0 \fB\-\-mode\fR mo \fB\-v\fR 3.0 // for Media Overlays validation \fB\-\-mode\fR exp // for expanded EPUB archives .PP This tool also accepts the following options: \fB\-\-save\fR = saves the epub created from the expanded epub \fB\-\-out\fR = output an assessment XML document file (use \- to output to console) \fB\-\-xmp\fR = output an assessment XMP document file (use \- to output to console) \fB\-\-json\fR = output an assessment JSON document file (use \- to output to console) \fB\-m\fR = same as \fB\-\-mode\fR \fB\-p\fR = same as \fB\-\-profile\fR \fB\-o\fR = same as \fB\-\-out\fR \fB\-x\fR = same as \fB\-\-xmp\fR \fB\-j\fR = same as \fB\-\-json\fR \fB\-\-failonwarnings[\fR+|\-] = By default, the tool returns a 1 if errors are found in the file or 0 if no errors are found. Using \fB\-\-failonwarnings\fR will cause the process to exit with a status of .IP 1 if either warnings or errors are present and 0 only when there are no errors or warnings. .PP \fB\-q\fR, \fB\-\-quiet\fR = no message on console, except errors, only in the output \fB\-f\fR, \fB\-\-fatal\fR = include only fatal errors in the output \fB\-e\fR, \fB\-\-error\fR = include only error and fatal severity messages in ouput \fB\-w\fR, \fB\-\-warn\fR = include fatal, error, and warn severity messages in output \fB\-u\fR, \fB\-\-usage\fR = include ePub feature usage information in output .IP (default is OFF); if enabled, usage information will always be included in the output file .PP \fB\-\-locale\fR = output localized messages according to the provided IETF BCP 47 language tag string. .PP \fB\-l\fR, \fB\-\-listChecks\fR [] = list message ids and severity levels to the custom message file named .IP or the console .PP \fB\-c\fR, \fB\-\-customMessages\fR [] = override message severity levels as defined in the custom message file named .PP \fB\-\-version\fR = displays the EPUBCheck version .PP \fB\-h\fR, \-? or \fB\-\-help\fR = displays this help message .PP epubcheck completed .SH AUTHOR .IP \[bu] 2 Peter Sorotokin .IP \[bu] Garth Conboy .IP \[bu] Markus Gylling .IP \[bu] Piotr Kula .IP \[bu] Paul Norton .IP \[bu] Jessica Hekman .IP \[bu] George Bina .IP \[bu] Bogdan Iordache .IP \[bu] Ionut-Maxim Margelatu .IP \[bu] 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. This manual page was written by Mathieu Malaterre for the Debian GNU/Linux system, but may be used by others.