File epubcheck.xml of Package epubcheck

Overview Repositories Revisions Requests Users Attributes Meta

File epubcheck.xml of Package epubcheck

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
                         "http://www.docbook.org/xml/4.4/docbookx.dtd"
[
<!ENTITY cmd "epubcheck">
]>
<refentry lang="en" id="epubcheck.man">
    <refentryinfo>
        <productname>&cmd;</productname>
        <authorgroup>
            <corpauthor>
                <remark>epubcheck Project</remark>
            </corpauthor>
            <author>
                <firstname>Peter</firstname>
                <surname>Sorotokin</surname>
                <contrib>Developer</contrib>
            </author><author>
                <firstname>Garth</firstname>
                <surname>Conboy</surname>
            </author><author>
                <firstname>Markus</firstname>
                <surname>Gylling</surname>
            </author><author>
                <firstname>Piotr</firstname>
                <surname>Kula</surname>
            </author><author>
                <firstname>Jessica</firstname>
                <surname>Hekman</surname>
            </author><author>
                <firstname>George</firstname>
                <surname>Bina</surname>
            </author><author>
                <firstname>Bogdan</firstname>
                <surname>Iordache</surname>
            </author></authorgroup></refentryinfo>
    <refmeta>
        <refentrytitle>&cmd;</refentrytitle>
        <manvolnum>1</manvolnum>
        <refmiscinfo class="version">@VERSION@</refmiscinfo>
    </refmeta>
    <refnamediv>
        <refname>&cmd;</refname>
        <refpurpose>Validates EPUB files (Version 2.0 and 3.0)</refpurpose>
    </refnamediv>
    <refsynopsisdiv id="epubcheck.synopsis">
        <title>Synopsis</title>
        <cmdsynopsis>
            <command>&cmd;</command>
            <arg choice="opt">-mode</arg>
            <arg choice="opt">MODE</arg>
            <arg choice="req">file</arg>
        </cmdsynopsis>
    </refsynopsisdiv>
    <refsect1>
        <title>Options</title>
        <para>These Options can only be used with -mode</para>
        <variablelist>
            <varlistentry>
                <term>
                    <option>-h</option>
                </term>
                <listitem>
                    <para>shows help</para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>
                    <option>opf</option>
                </term>
                <listitem>
                    <para>validates package document</para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>
                    <option>nav</option>
                </term>
                <listitem>
                    <para>validates navigation from document</para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>
                    <option>mo</option>
                </term>
                <listitem>
                    <para>media overlay validation</para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>
                    <option>xhtml</option>
                </term>
                <listitem>
                    <para>validates xhtml files</para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>
                    <option>svg</option>
                </term>
                <listitem>
                    <para>validates svg files</para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>
                    <option>exp</option>
                </term>
                <listitem>
                    <para>saves the created archive</para>
                </listitem>
            </varlistentry>
        </variablelist>
    </refsect1>
    <refsect1>
        <title>Requirements</title>
        <para>epubcheck validates your EPUB file</para>
    </refsect1>
    <refsect1 id="epubcheck.examples">
        <title>Examples</title>
        <para>Run epubcheck from your commandline as follows:</para>
        <screen>$ <command>epubcheck</command> linux.epub
$ <command>epubcheck</command> -mode mo linux.epub
$ <command>epubcheck</command> /path -mode exp -save</screen>
    </refsect1>
    <refsect1>
        <title>Further Informations</title>
        <para>Every EPUB file consists of 3 specifications:</para>
        <para>
            <variablelist>
                <varlistentry>
                    <term>
                        <ulink url="http://www.idpf.org/epub/20/spec/OPS_2.0.1_draft.htm">Open
                            Publication Structure</ulink>
                    </term>
                    <listitem>
                        <para>describes the content in XHTML </para>
                    </listitem>
                </varlistentry>
                <varlistentry>
                    <term>
                        <ulink url="http://www.idpf.org/epub/20/spec/OPF_2.0_latest.htm">Open
                            Packaging Format</ulink>
                    </term>
                    <listitem>
                        <para>describes the different parts like images and navigation in XML</para>
                    </listitem>
                </varlistentry>
                <varlistentry>
                    <term>
                        <ulink url="http://www.idpf.org/epub/30/spec/epub30-ocf.html">OEBPS
                            Container Format</ulink>
                    </term>
                    <listitem>
                        <para>describes the content, structure and presentation in XML</para>
                    </listitem>
                </varlistentry>
            </variablelist>
        </para>
        <para>Other specifications are XML, CSS, XHTML, <ulink
                url="http://wiki.mobileread.com/wiki/NCX">NCX</ulink>, <ulink
                url="http://de.wikipedia.org/wiki/Dublin_Core">Dublin Core</ulink> and Zip.
            epubcheck is available in Version 3.0 and Version 2.0. In version 3.0 you can work with
            HTML5, MathML and Skripting. Following link to read more about the differences <ulink
                url="http://www.idpf.org/epub/30/spec/epub30-changes.html">Version3.0</ulink>.
        </para>
    </refsect1>
    <refsect1>
        <title>Copyright</title>
        <para>License New BSD License <ulink url="http://gnu.org/licenses/gpl.html">BSD 3-Clause
                License</ulink>.</para>
    </refsect1>
</refentry>

Places

File epubcheck.xml of Package epubcheck

Places