source: gnome/add/epiphany.xml@ 4a256da

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

  <!ENTITY epiphany-download-http "&gnome-download-http;/epiphany/1.8/epiphany-&epiphany-version;.tar.bz2">
  <!ENTITY epiphany-download-ftp  "&gnome-download-ftp;/epiphany/1.8/epiphany-&epiphany-version;.tar.bz2">
  <!ENTITY epiphany-md5sum        "317e18f1d415a37d3b9934c106edf34a">
  <!ENTITY epiphany-size          "3.3 MB">
  <!ENTITY epiphany-buildsize     "66.4 MB">
  <!ENTITY epiphany-time          "1.0 SBU">
]>

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

  <sect1info>
    <othername>$LastChangedBy$</othername>
    <date>$Date$</date>
    <keywordset>
      <keyword role="package">epiphany-&epiphany-version;.tar</keyword>
      <keyword role="ftpdir">epiphany</keyword>
    </keywordset>
  </sect1info>

  <title>Epiphany-&epiphany-version;</title>

  <indexterm zone="epiphany">
    <primary sortas="a-Epiphany">Epiphany</primary>
  </indexterm>

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

    <para><application>Epiphany</application> is a simple yet powerful
    <application>GNOME</application> web browser targeted at non-technical
    users. Its principles are simplicity and standards compliance.</para>

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

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required"><xref linkend="gnome-desktop"/>,
    <xref linkend="libgnomeprintui"/>,
    <xref linkend="which"/>,
    <xref linkend="iso-codes"/>, and
    <xref linkend="mozilla"/> or
    <xref linkend="firefox"/> or
    <xref linkend="thunderbird"/></para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional"><xref linkend="startup-notification"/>,
    <xref linkend="dbus"/>,
    <ulink url="http://ftp.gnome.org/pub/GNOME/sources/gnome-python/">GNOME-Python</ulink>
    (requires <ulink url="http://www.pygtk.org/">PyGTK</ulink> and can use
    <ulink url="http://ftp.gnome.org/pub/GNOME/sources/pyorbit/">PyORBit</ulink>,
    see <xref linkend="hal-runtime-dependencies"/>), and
    <xref linkend="gtk-doc"/></para>

  </sect2>

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

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

<screen><userinput>./configure --prefix=`pkg-config --variable=prefix ORBit-2.0` \
            --sysconfdir=&gnome-etc-dir; \
            --localstatedir=/var/lib &amp;&amp;
make</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 install</userinput></screen>

    <para>If you have <application>GNOME-Python</application> installed, the
    <application>Epiphany</application> <application>Python</application>
    extension is automatically built. If your $GNOME_PREFIX is anything but
    <filename class='directory'>/usr</filename> and you have
    <application>GNOME-Python</application> installed, as the
    <systemitem class="username">root</systemitem> user create the following
    symbolic link in the <application>PyGTK</application> extensions directory
    of <filename class='directory'>/usr/share</filename>:</para>

<screen role="root"><userinput>ln -v -s $GNOME_PREFIX/share/pygtk/2.0/defs/epiphany.defs \
    /usr/share/pygtk/2.0/defs</userinput></screen>

  </sect2>

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

    <para><parameter>--sysconfdir=&gnome-etc-dir;</parameter>: This switch puts
    configuration files in <filename class="directory">&gnome-etc-dir;</filename>
    instead of <filename class="directory">$GNOME_PREFIX/etc</filename>.</para>

    <para><parameter>--localstatedir=/var/lib</parameter>: This switch
    puts <application>ScrollKeeper</application> files in
    <filename class="directory">/var/lib/scrollkeeper</filename> instead of
    <filename class="directory">$GNOME_PREFIX/var/scrollkeeper</filename>.</para>

    <para><option>--enable-dbus</option>: Use this parameter if you have
    <application>D-BUS</application> installed and wish to build
    <application>D-BUS</application> support into the
    <command>epiphany</command> program.</para>

    <para><option>--enable-zeroconf</option>: Use this parameter if you wish
    to enable Zeroconf bookmarks support. You must have built GNOME VFS with
    <ulink url="http://www.porchdogsoft.com/products/howl/">Howl</ulink>
    support for this option to work properly.</para>

  </sect2>

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

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

      <seglistitem>
        <seg>epiphany</seg>
        <seg>None</seg>
        <seg>&gnome-etc-dir;/gconf/gconf.xml.defaults/apps/epiphany,
        &gnome-etc-dir;/gconf/gconf.xml.defaults/schemas/apps/epiphany,
        $GNOME_PREFIX/include/epiphany-1.8,
        $GNOME_PREFIX/share/epiphany,
        $GNOME_PREFIX/share/gnome/help/epiphany,
        $GNOME_PREFIX/share/gtk-doc/html/epiphany, and
        $GNOME_PREFIX/share/omf/epiphany</seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="epiphany-prog">
        <term><command>epiphany</command></term>
        <listitem>
          <para>is a <application>GNOME</application> web browser based on
          the <application>Mozilla</application> rendering engine.</para>
          <indexterm zone="epiphany epiphany-prog">
            <primary sortas="b-epiphany">epiphany</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>