source: gnome/add/gnome-documents.xml@ 059db80

<?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.2/gnome-documents-&gnome-documents-version;.tar.xz">
  <!ENTITY gnome-documents-download-ftp  "&gnome-download-ftp;/gnome-documents/0.2/gnome-documents-&gnome-documents-version;.tar.xz">
  <!ENTITY gnome-documents-md5sum        "3fff556f631ae55ec5d9dd256e986701">
  <!ENTITY gnome-documents-size          "416 KB">
  <!ENTITY gnome-documents-buildsize     "6.1 MB">
  <!ENTITY gnome-documents-time          "0.2 SBU">
]>

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

  <sect1info>
    <othername>$LastChangedBy$</othername>
    <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 enabled),
    <xref linkend="glib2"/>,
    <xref linkend="gobject-introspection"/>,
    <xref linkend="gtk3"/>,
    <xref linkend="gnome-desktop"/>,
    <xref linkend="tracker"/>,
    <xref linkend="gnome-online-accounts"/>,
    <xref linkend="libgdata"/>, and
    <xref linkend="liboauth"/></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=$GNOME_PREFIX \
            --libexecdir=$GNOME_PREFIX/lib/gnome-documents &amp;&amp;
make</userinput></screen>

    <para>This package&apos;s testsuite is only intended to be used by the
    maintainer to check i18n files.</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=$GNOME_PREFIX/lib/gnome-documents</parameter>: This
    parameter ensures <filename>gd-tracker-gdata-miner</filename> is not installed in
    <filename class="directory">$GNOME_PREFIX/libexec</filename> which would violate the
    FHS.</para>

  </sect2>

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

    <segmentedlist>
      <segtitle>Installed Programs</segtitle>
      <segtitle>Installed Library</segtitle>
      <segtitle>Installed Directories</segtitle>

      <seglistitem>
        <seg>gd-tracker-gdata-miner and gnome-documents</seg>
        <seg>libgdprivate-1.0.so</seg>
        <seg><envar>$GNOME_SYSCONFDIR</envar>/{lib/gnome-documents,share/gnome-documents/{icons,js/util,style}}</seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="gd-tracker-gdata-miner">
        <term><command>gd-tracker-gdata-miner</command></term>
        <listitem>
          <para>indexes google documents shared to you.</para>
          <indexterm zone="gnome-documents gd-tracker-gdata-miner">
            <primary sortas="b-gd-tracker-gdata-miner">gd-tracker-gdata-miner</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <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-prog">gnome-documents-prog</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <!--<varlistentry id="libgdprivate-1">
        <term><filename class='libraryfile'>libgdprivate-1.0.so</filename></term>
        <listitem>
          <para>contains functions that .....</para>
          <indexterm zone="gnome-documents libgdprivate-1">
            <primary sortas="c-libgdprivate-1">libgdprivate-1.0.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>-->

    </variablelist>

  </sect2>

</sect1>