Running

Running EpubCheck

To run the tool you need Java (1.6 or above). Any Operating System should do.

EpubCheck is a command line tool, all detected errors are simply printed to stderr output stream

There's no native GUI – however, there are some thirdparty apps offering a GUI. See the third-party apps section for further details.

Running from Commandline

You can run EpubCheck from the command line in the following modes:

Basic mode

java -jar epubcheck-3.0.1.jar file.epub

Advanced mode

java -jar epubcheck-3.0.1.jar singleFile -mode MODE -v VERSION

• MODE must be one of the following:

• opf for package document validation;

• nav for navigation document validation (available only for version 3.0);

• mo for media overlay validation (available only for version 3.0);

• xhtml;

• svg;

• exp for Expanded EPUB validation (see next section)

• VERSION must be one of

• 2.0

• 3.0

Note that when validating a single file, only a subset of the available tests is run. Also, when validating a full EPUB, both mode and version are ignored.

Expanded mode

java -jar epubcheck-3.0.1.jar folder/ -mode exp [-save]

When using expanded mode, there's an optional flag -save to save the created archive upon validation.

Additional flags

• -out file.xml outputs an assessment XML document
• -quiet or -q outputs only if there is any warning or error
• -help, --help or -? displays a help message

Third-party apps

There are a bunch of third-party apps which offer a graphical user interface (GUI) for EpubCheck. You don't need any commandline or 'developer' knowledge to use them...

• pagina EPUB-Checker
• Rainwater Soft ePubChecker (seems to be deprecated)

If you know of more, just let us know...