Repository navigation
Running
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.
You can run EpubCheck from the command line in the following modes:
java -jar epubcheck-3.0.1.jar file.epub
java -jar epubcheck-3.0.1.jar singleFile -mode MODE -v VERSION
-
MODE must be one of the following:
-
opffor package document validation; -
navfor navigation document validation (available only for version 3.0); -
mofor media overlay validation (available only for version 3.0); -
xhtml; -
svg; -
expfor 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.
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.
-
-out file.xmloutputs an assessment XML document -
-quietor-qoutputs only if there is any warning or error -
-help,--helpor-?displays a help message