source: archive/gnome/gnome-documents.xml@ 48b59802

<?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 gnome-documents-download-http
           "&gnome-download-http;/gnome-documents/0.4/gnome-documents-&gnome-documents-version;.tar.xz">
  <!ENTITY gnome-documents-download-ftp
           "&gnome-download-ftp;/gnome-documents/0.4/gnome-documents-&gnome-documents-version;.tar.xz">
  <!ENTITY gnome-documents-md5sum        "465de85bf9bac48ff300b1bf6aa5851c">
  <!ENTITY gnome-documents-size          "492 KB">
  <!ENTITY gnome-documents-buildsize     "10 MB">
  <!ENTITY gnome-documents-time          "0.4 SBU">
]>

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

  <sect1info>
    <date>$Date$</date>
  </sect1info>

  <title>gnome-documents-&gnome-documents-version;</title>

  <indexterm zone="gnome-documents">
    <primary sortas="a-gnome-documents">gnome-documents</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to GNOME Documents</title>

    <para>
      <application>GNOME Documents</application> is a document viewer which supports
      local documents (using the <application>Tracker</application> search engine) and
      Google Documents. For local documents, this appears to be restricted to PDF and PS
      files.
    </para>

    &lfs70_checked;

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

    <bridgehead renderas="sect3">GNOME Documents Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="clutter-gtk"/>,
      <xref linkend="evince"/> (with introspection support enabled),
      <xref linkend="gjs"/>,
      <xref linkend="gnome-desktop"/>,
      <xref linkend="gnome-online-accounts"/>,
      <xref linkend="libgdata"/> and
      <xref linkend="tracker"/>
    </para>

    <bridgehead renderas="sect4">Additional Runtime Dependency</bridgehead>
    <para role="optional">
      Although this package uses <application>Evince</application>,
      it needs <xref linkend="gimp"/> to display documents.
    </para>

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

  <sect2 role="installation">
    <title>Installation of GNOME Documents</title>

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

<screen><userinput>./configure --prefix=/usr \
            --libexecdir=/usr/lib/gnome-documents &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>

  </sect2>

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

    <para>
      <parameter>--libexecdir=/usr/lib/gnome-documents</parameter>: This
      parameter ensures <filename>gd-tracker-gdata-miner</filename> is not installed in
      <filename class="directory">/usr/libexec</filename>.
    </para>

  </sect2>

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

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

      <seglistitem>
        <seg>
          gnome-documents
        </seg>
        <seg>
          /usr/lib/gnome-documents and
          /usr/share/gnome-documents
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="gnome-documents-prog">
        <term><command>gnome-documents</command></term>
        <listitem>
          <para>
            displays (indexed) shared and local documents.
          </para>
          <indexterm zone="gnome-documents gnome-documents-prog">
            <primary sortas="b-gnome-documents">gnome-documents</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>