File epubcheck.pod of Package epubcheck
=encoding utf8 =head1 NAME epubcheck - the official conformance checker for EPUB publications. =head1 SYNOPSYS epubcheck I<file> [I<option>...] =head1 DESCRIPTION EPUBCheck is the official conformance checker for EPUB publications. EPUBCheck can be run as a standalone command-line tool or used as a Java library. EPUBCheck is open source software, maintained by the L<DAISY Consortium|http://www.daisy.org/> on behalf of L<W3C|https://www.w3.org/publishing/epubcheck_fundraising>. =head1 OPTIONS =over =item B<--mode> I<mode> B<-v> I<version> If checking a non-epub file, the epub version of the file must be specified using B<-v> and the type of the file using B<--mode>. The default version is: 3.0. Modes and versions supported: =over =item B<--mode> opf B<-v> 2.0 =item B<--mode> opf B<-v> 3.0 =item B<--mode> xhtml B<-v> 2.0 =item B<--mode> xhtml B<-v> 3.0 =item B<--mode> svg B<-v> 2.0 =item B<--mode> svg B<-v> 3.0 =item B<--mode> nav B<-v> 3.0 =item B<--mode> mo B<-v> 3.0 for Media Overlays validation =item B<--mode> exp for expanded EPUB archives. =back =item B<--save> saves the epub created from the expanded epub =item B<-o>, B<--out> I<file> output an assessment XML document file (use - to output to console) =item B<-x>, B<--xmp> I<file> output an assessment XMP document file (use - to output to console) =item B<-j>, B<--json> I<file> output an assessment JSON document file (use - to output to console) =item B<-m> I<file> same as B<--mode> =item B<-p>, B<--profile> I<profile> a validation profile. Validation profiles supported: =over =item B<--profile> default The default validation profile. =item B<--profile> dict Validates against the EPUB Dictionaries and Glossaries specification. =item B<--profile> edupub Validates against the EDUPUB Profile. =item B<--profile> idx Validates against the EPUB Indexes specification. =item B<--profile> preview Validates against the EPUB Previews specification. =back =item B<--failonwarnings>[+|-] By default, the tool returns a 1 if errors are found in the file or 0 if no errors are found. Using B<--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. =item B<-q>, B<--quiet> No message on console, except errors, only in the output. =item B<-f>, B<--fatal> Include only fatal errors in the output. =item B<-e>, B<--error> Include only error and fatal severity messages in ouput. =item B<-w>, B<--warn> Include fatal, error, and warn severity messages in output. =item B<-u>, B<--usage> Include ePub feature usage information in output (default is OFF); if enabled, usage information will always be included in the output file. =item B<--locale> I<locale> Output localized messages according to the provided IETF BCP 47 language tag string. =item B<-l>, B<--listChecks> [I<file>] list message ids and severity levels to the custom message file named I<file> or the console =item B<-c>, B<--customMessages> [I<file>] Override message severity levels as defined in the custom message file named I<file>. =item B<--version> Displays the EPUBCheck version. =item B<-h>, B<-?> or B<--help> Displays this help message. =back =head1 SEE ALSO Documentation on how to use EPUBCheck, to contribute to the project or to translate messages is available on the L<EPUBCheck wiki|https://github.com/w3c/epubcheck/wiki>. =head1 CREDITS EPUBCheck was developed by the L<DAISY Consortium|https://www.daisy.org/>, on behalf of W3C. Initial EPUBCheck development was largely done at L<Adobe|https://www.adobe.com/>. A significant part of EPUBCheck functionality comes from the schema validation tool L<Jing|https://relaxng.org/jclark/jing.html>, used with schemas from the L<Nu HTML Checker|https://validator.github.io/validator/>, L<IDPF|https://idpf.org/>, and L<DAISY|https://www.daisy.org/>. Past and present EPUBCheck developers include: Romain Deltour, Matt Garrish, Tobias Fischer, Markus Gylling, Steve Antoch, Peter Sorotokin, Thomas Ledoux, Masayoshi Takahashi, Paul Norton, Piotr Kula, Arwen Pond, Liza Daly, Garth Conboy, and L<several others|https://github.com/w3c/epubcheck/graphs/contributors>. Many thanks to the numerous people who have contributed to the evolution of EPUBCheck through bug reports, pull requests, and translations! =head1 LICENSE EPUBCheck is made available under the terms of the L<3-Clause BSD License|http://opensource.org/licenses/BSD-3-Clause>.
