source: pst/ps/mupdf.xml@ 88499366

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;

<!--Using archive URL, because when a new version is released, older and new
can be found there, no need to change directory -->
  <!ENTITY mupdf-download-http "http://www.mupdf.com/downloads/archive/mupdf-&mupdf-version;-source.tar.gz">
  <!ENTITY mupdf-download-ftp  " ">
  <!ENTITY mupdf-md5sum        "fbe3313cc2e7455aa21cacc64262088b">
  <!ENTITY mupdf-size          "40 MB">
  <!ENTITY mupdf-buildsize     "325 MB">
  <!ENTITY mupdf-time          "0.5 SBU">
]>

<sect1 id="mupdf" xreflabel="mupdf-&mupdf-version;">
  <?dbhtml filename="mupdf.html"?>

  <sect1info>
    <othername>$LastChangedBy$</othername>
    <date>$Date$</date>
  </sect1info>

  <title>MuPDF-&mupdf-version;</title>

  <indexterm zone="mupdf">
    <primary sortas="a-mupdf">mupdf</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to MuPDF</title>

    <para>
      <application>MuPDF</application> is a lightweight PDF and XPS viewer.
    </para>

    &lfs7a_checked;

    <bridgehead renderas="sect3">Package Information</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>
          Download (HTTP): <ulink url="&mupdf-download-http;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Download (FTP): <ulink url="&mupdf-download-ftp;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Download MD5 sum: &mupdf-md5sum;
        </para>
      </listitem>
      <listitem>
        <para>
          Download size: &mupdf-size;
        </para>
      </listitem>
      <listitem>
        <para>
          Estimated disk space required: &mupdf-buildsize;
        </para>
      </listitem>
      <listitem>
        <para>
          Estimated build time: &mupdf-time;
        </para>
      </listitem>
    </itemizedlist>

    <bridgehead renderas="sect3">Additional Downloads</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>
          Recommended patch:
          <ulink url="&patch-root;/mupdf-&mupdf-version;-shared_libs-1.patch"/>
        </para>
      </listitem>
    </itemizedlist>

    <bridgehead renderas="sect3">MuPDF Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="xorg7-lib"/>
    </para>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <xref linkend="harfbuzz"/>,
      <xref linkend="libjpeg"/>,
      <xref linkend="openjpeg2"/>, and
      <xref linkend="curl"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="openssl"/>,
      <xref linkend="xdg-utils"/> (runtime),
      <ulink url="http://www.glfw.org/">GLFW</ulink>, and
      <ulink url="http://downloads.ghostscript.com/public/jbig2dec/">jbig2dec</ulink>
    </para>

    <bridgehead renderas="sect4">Required (runtime)</bridgehead>
    <para role="required">
      <xref linkend="x-window-system"/>
    </para>

    <para condition="html" role="usernotes">
      User Notes: <ulink url="&blfs-wiki;/mupdf"/>
    </para>
  </sect2>

  <sect2 role="installation">
    <title>Installation of MuPDF</title>

    <para>
      Install <application>MuPDF</application> by running the following
      commands:
    </para>

<screen><userinput>rm -rf thirdparty/curl     &amp;&amp;
rm -rf thirdparty/freetype &amp;&amp;
rm -rf thirdparty/harfbuzz &amp;&amp;
rm -rf thirdparty/jpeg     &amp;&amp;
rm -rf thirdparty/openjpeg &amp;&amp;
rm -rf thirdparty/zlib     &amp;&amp;

sed '/OPJ_STATIC$/d' -i source/fitz/load-jpx.c &amp;&amp;

patch -Np1 -i ../mupdf-&mupdf-version;-shared_libs-1.patch &amp;&amp;

make build=release</userinput></screen>

    <para>
      This package does not come with a test suite.
    </para>

    <para>
      Now, as the <systemitem class="username">root</systemitem> user:
    </para>

<screen role="root"><userinput>make prefix=/usr                      \
     build=release                    \
     docdir=/usr/share/doc/mupdf-&mupdf-version; \
     install                          &amp;&amp;
ln -sfv mupdf-x11-curl /usr/bin/mupdf</userinput></screen>

  </sect2>

  <sect2 role="commands">
    <title>Command Explanations</title>

    <para>
      <command>sed '/OPJ_STATIC$/d' ... </command>: Remove a switch, which
      prevents using shared libraries for <application>openjpeg2</application>.
    </para>

    <para>
      <command>ln -sfv mupdf-x11-curl /usr/bin/mupdf </command>: Three
      <command>mupdf</command> executables are installed:
      <command>mupdf-gl</command>, <command>mupdf-x11</command>, and
      <command>mupdf-x11-curl</command>. This symbolic link allows to choose
      which one is used when running <command>mupdf</command>.
    </para>

  </sect2>

  <sect2 role="content">
    <title>Contents</title>

    <segmentedlist>
      <segtitle>Installed Program</segtitle>
      <segtitle>Installed Libraries</segtitle>
      <segtitle>Installed Directories</segtitle>

      <seglistitem>
        <seg>mujstest, mupdf(symlink), mupdf-gl, mupdf-x11, mupdf-x11-curl,
        muraster, mutool</seg>
        <seg>libmupdf.so, libmupdfthird.so</seg>
        <seg>/usr/include/mupdf, /usr/share/doc/mupdf-&mupdf-version;</seg>
      </seglistitem>
    </segmentedlist>

    <variablelist>
      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
      <?dbfo list-presentation="list"?>
      <?dbhtml list-presentation="table"?>

      <varlistentry id="mujstest">
        <term><command>mujstest</command></term>
        <listitem>
          <para>
            is a test program for mupdf + javascript
          </para>
          <indexterm zone="mupdf mujstest">
            <primary sortas="b-mujstest">mujstest</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="mupdf-prog">
        <term><command>mupdf</command></term>
        <listitem>
          <para>
            is a program for viewing PDF, XPS, EPUB, and CBZ documents,
            and various image formats such as PNG, JPEG, GIFF, and TIFF.
          </para>
          <indexterm zone="mupdf mupdf-prog">
            <primary sortas="b-mupdf">mupdf</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="mupdf-gl">
        <term><command>mupdf-gl</command></term>
        <listitem>
          <para>
            same as <command>mupdf</command>, using an opengl renderer.
          </para>
          <indexterm zone="mupdf mupdf-gl">
            <primary sortas="b-mupdf-gl">mupdf-gl</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="mupdf-x11">
        <term><command>mupdf-x11</command></term>
        <listitem>
          <para>
            same as <command>mupdf</command>, using an X Window renderer.
          </para>
          <indexterm zone="mupdf mupdf-x11">
            <primary sortas="b-mupdf-x11">mupdf-x11</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="mupdf-x11-curl">
        <term><command>mupdf-x11-curl</command></term>
        <listitem>
          <para>
            same as <command>mupdf</command>, using an X Window renderer,
            with the capability of rendering web pages, using an
            <quote>http://...</quote> url.
          </para>
          <indexterm zone="mupdf mupdf-x11-curl">
            <primary sortas="b-mupdf-x11-curl">mupdf-x11-curl</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="muraster">
        <term><command>muraster</command></term>
        <listitem>
          <para>
            transforms files in one of the formats displayable by mupdf into
            a graphic file.
          </para>
          <indexterm zone="mupdf muraster">
            <primary sortas="b-muraster">muraster</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="mutool">
        <term><command>mutool</command></term>
        <listitem>
          <para>
            deals with document files in various manners.
          </para>
          <indexterm zone="mupdf mutool">
            <primary sortas="b-mutool">mutool</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libmupdf">
        <term><filename class="libraryfile">libmupdf.so</filename></term>
        <listitem>
          <para>
            contains the mupdf API functions.
          </para>
          <indexterm zone="mupdf libmupdf">
            <primary sortas="c-libmupdf">libmupdf.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libmupdfthird">
        <term><filename class="libraryfile">libmupdfthird.so</filename></term>
        <listitem>
          <para>
            contains the third party libraries compiled for mudpf.
          </para>
          <indexterm zone="mupdf libmupdfthird">
            <primary sortas="c-libmupdfthird">libmupdfthird.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>