source: general/genlib/folks.xml@ f41cb316

<?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 folks-download-http "&gnome-download-http;/folks/0.6/folks-&folks-version;.tar.xz">
  <!ENTITY folks-download-ftp  "&gnome-download-ftp;/folks/0.6/folks-&folks-version;.tar.xz">
  <!ENTITY folks-md5sum        "49b739a9359a9b030844a2719cf5bb45">
  <!ENTITY folks-size          "1.4 MB">
  <!ENTITY folks-buildsize     "53 MB">
  <!ENTITY folks-time          "1.0 SBU">
]>

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

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

  <title>Folks-&folks-version;</title>

  <indexterm zone="folks">
    <primary sortas="a-Folks">Folks</primary>
  </indexterm>

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

    <para>The <application>Folks</application> package is a library that
    aggregates people from multiple sources (eg,
    <application>Telepathy</application> connection managers and eventually
    <application>evolution data server</application>, Facebook, etc.) to create
    metacontacts.</para>

    &lfs70_checked;

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

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="intltool"/>,
      <xref linkend="libgee"/>, and
      <xref linkend="telepathy-glib"/>
    </para>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <xref linkend="evolution-data-server"/>,
      <xref linkend="gobject-introspection"/> and
      <xref linkend="vala"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <ulink url="http://ftp.gnome.org/pub/gnome/sources/libsocialweb/">
      libsocialweb</ulink>,
      <xref linkend="tracker"/> and 
      <ulink url="http://live.gnome.org/Valadoc/">valadoc</ulink> 
      (Required for generating the documentation)
    </para>

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

  </sect2>

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

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

<screen><userinput>./configure --prefix=/usr --enable-vala &amp;&amp;
make</userinput></screen>

    <para>To test the results, issue: <command>make check</command>.</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>--enable-vala</parameter>: This parameter enables building
    from the Vala sources.</para>

    <para><parameter>--enable-tracker-backend</parameter>: This parameter enables
    documentation generation.</para>

    <para><parameter>--enable-docs</parameter>: This parameter enables
    documentation generation.</para>

  </sect2>

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

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

      <seglistitem>
        <seg>
          folks-import and folks-inspect
        </seg>
        <seg>
          libfolks-eds.so, libfolks-libsocialweb.so,
          libfolks.so, libfolks-telepathy.so and
          libfolks-tracker.so
        </seg>
        <seg>
          /usr/include/folks and /usr/lib/folks
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="folks-import">
        <term><command>folks-import</command></term>
        <listitem>
          <para>is used to import meta-contact information to 
          libfolks.</para>
          <indexterm zone="folks folks-import">
            <primary sortas="b-folks-import">folks-import</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="folks-inspect">
        <term><command>folks-inspect</command></term>
        <listitem>
          <para>is used to inspect meta-contact information in 
          libfolks.</para>
          <indexterm zone="folks folks-inspect">
            <primary sortas="b-folks-inspect">folks-inspect</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libfolks-eds">
        <term><filename class='libraryfile'>libfolks-eds.so</filename></term>
        <listitem>
          <para>contains Evolution-specific implementations of the libfolks
          classes.</para>
          <indexterm zone="folks libfolks-eds">
            <primary sortas="c-libfolks-eds">libfolks-eds.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libfolks-libsocialweb">
        <term><filename class='libraryfile'>libfolks-libsocialweb.so</filename></term>
        <listitem>
          <para>contains libsocialweb-specific implementations of the libfolks
          classes.</para>
          <indexterm zone="folks libfolks-libsocialweb">
            <primary sortas="c-libfolks-libsocialweb">libfolks-libsocialweb.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

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

      <varlistentry id="libfolks-telepathy">
        <term><filename class='libraryfile'>libfolks-telepathy.so</filename></term>
        <listitem>
          <para>contains Telepathy-specific implementations of the libfolks
          classes.</para>
          <indexterm zone="folks libfolks-telepathy">
            <primary sortas="c-libfolks-telepathy">libfolks-telepathy.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libfolks-tracker">
        <term><filename class='libraryfile'>libfolks-tracker.so</filename></term>
        <listitem>
          <para>contains Tracker-specific implementations of the libfolks
          classes.</para>
          <indexterm zone="folks libfolks-tracker">
            <primary sortas="c-libfolks-tracker">libfolks-tracker.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>