source: xfce/apps/midori.xml@ 9d37710

<?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;

  <!ENTITY midori-download-http
           "http://www.midori-browser.org/downloads/midori_&midori-version;_all_.tar.bz2">
  <!ENTITY midori-download-ftp  " ">
  <!ENTITY midori-md5sum        "b89e25e74199d705e74767499a415976">
  <!ENTITY midori-size          "1.3 MB">
  <!ENTITY midori-buildsize     "63 MB (additional 1 MB for the tests)">
  <!ENTITY midori-time          "0.5 SBU (additional less than 0.1 SBU
                                 for the tests)">
]>

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

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

  <title>Midori-&midori-version;</title>

  <indexterm zone="midori">
    <primary sortas="a-Midori">Midori</primary>
  </indexterm>

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

    <para>
      <application>Midori</application> is a lightweight web browser that uses
      <application>WebKitGTK+</application>.
    </para>

    &lfs76_checked;

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

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="cmake"/>,
      <xref linkend="libnotify"/>,
      <xref linkend="webkitgtk2"/> (see "Command Explanations"), and
      <xref linkend="vala"/>
    </para>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <xref linkend="librsvg"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="gtk-doc"/> and
      <xref linkend="libzeitgeist"/>
    </para>

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

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

    <para>
      The tarball is not compressed from a directory, thus it is better to
      create a directory to uncompress it:
    </para>

<screen><userinput>mkdir -v midori-&midori-version; &amp;&amp;
tar xf midori_&midori-version;_all_.tar.bz2 -C midori-&midori-version; &amp;&amp;
cd midori-&midori-version;</userinput></screen>

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

<screen><userinput>cmake -DCMAKE_INSTALL_PREFIX=/usr                        \
      -DCMAKE_INSTALL_DOCDIR=/usr/share/doc/midori-&midori-version; \
      ..  &amp;&amp;
make</userinput></screen>

    <para>
      To test the results, issue: <command>make check</command> from an X
      terminal emulator.
    </para>

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

<screen role="root"><userinput>make install</userinput></screen>
  </sect2>

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

    <para>
      <option>-DUSE_GTK3=1</option>: Use this switch if you want to build
      <application>Midori</application> with
      <application>WebKitGTK+</application> built against <application>GTK+
      3</application>, because by default it chooses
      <application>WebKitGTK+</application> built against <application>GTK+
      2</application>.
    </para>

    <para>
      <option>-DUSE_APIDOCS=1</option>: Use this switch if
      <application>GTK-Doc</application> is installed and you
      wish to build and install the API documentation. 
    </para>

  </sect2>

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

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

      <seglistitem>
        <seg>
          midori
        </seg>
        <seg>
          libmidori-core.so and several libraries under /usr/lib/midori
        </seg>
        <seg>
          /etc/xdg/midori,
          /usr/lib/midori,
          /usr/share/doc/midori and
          /usr/share/midori
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="midori-prog">
        <term><command>midori</command></term>
        <listitem>
          <para>
            is a lightweight <application>WebKitGTK+</application> browser.
          </para>
          <indexterm zone="midori midori-prog">
            <primary sortas="b-midori">midori</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>