[36bbe491] | 1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
| 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
| 4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
| 5 | %general-entities;
|
---|
| 6 |
|
---|
[dcea4e3] | 7 | <!ENTITY folks-download-http "&gnome-download-http;/folks/0.12/folks-&folks-version;.tar.xz">
|
---|
| 8 | <!ENTITY folks-download-ftp "&gnome-download-ftp;/folks/0.12/folks-&folks-version;.tar.xz">
|
---|
| 9 | <!ENTITY folks-md5sum "58bcf65a7b744ecbbb53f44dc8919204">
|
---|
| 10 | <!ENTITY folks-size "512 KB">
|
---|
| 11 | <!ENTITY folks-buildsize "69 MB (with tests)">
|
---|
| 12 | <!ENTITY folks-time "1.3 SBU (with tests)">
|
---|
[36bbe491] | 13 | ]>
|
---|
| 14 |
|
---|
| 15 | <sect1 id="folks" xreflabel="Folks-&folks-version;" revision="systemd">
|
---|
| 16 | <?dbhtml filename="folks.html"?>
|
---|
| 17 |
|
---|
| 18 | <sect1info>
|
---|
| 19 | <othername>$LastChangedBy$</othername>
|
---|
| 20 | <date>$Date$</date>
|
---|
| 21 | </sect1info>
|
---|
| 22 |
|
---|
| 23 | <title>Folks-&folks-version;</title>
|
---|
| 24 |
|
---|
| 25 | <indexterm zone="folks">
|
---|
| 26 | <primary sortas="a-Folks">Folks</primary>
|
---|
| 27 | </indexterm>
|
---|
| 28 |
|
---|
| 29 | <sect2 role="package">
|
---|
| 30 | <title>Introduction to Folks</title>
|
---|
| 31 |
|
---|
| 32 | <para>
|
---|
| 33 | <application>Folks</application> is a library that
|
---|
| 34 | aggregates people from multiple sources (e.g,
|
---|
| 35 | <application>Telepathy</application> connection managers and
|
---|
| 36 | eventually <application>Evolution Data Server</application>,
|
---|
| 37 | Facebook, etc.) to create metacontacts.
|
---|
| 38 | </para>
|
---|
| 39 |
|
---|
[dbea07b] | 40 | &lfs84_checked;
|
---|
[36bbe491] | 41 |
|
---|
| 42 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 43 | <itemizedlist spacing="compact">
|
---|
| 44 | <listitem>
|
---|
| 45 | <para>
|
---|
| 46 | Download (HTTP): <ulink url="&folks-download-http;"/>
|
---|
| 47 | </para>
|
---|
| 48 | </listitem>
|
---|
| 49 | <listitem>
|
---|
| 50 | <para>
|
---|
| 51 | Download (FTP): <ulink url="&folks-download-ftp;"/>
|
---|
| 52 | </para>
|
---|
| 53 | </listitem>
|
---|
| 54 | <listitem>
|
---|
| 55 | <para>
|
---|
| 56 | Download MD5 sum: &folks-md5sum;
|
---|
| 57 | </para>
|
---|
| 58 | </listitem>
|
---|
| 59 | <listitem>
|
---|
| 60 | <para>
|
---|
| 61 | Download size: &folks-size;
|
---|
| 62 | </para>
|
---|
| 63 | </listitem>
|
---|
| 64 | <listitem>
|
---|
| 65 | <para>
|
---|
| 66 | Estimated disk space required: &folks-buildsize;
|
---|
| 67 | </para>
|
---|
| 68 | </listitem>
|
---|
| 69 | <listitem>
|
---|
| 70 | <para>
|
---|
| 71 | Estimated build time: &folks-time;
|
---|
| 72 | </para>
|
---|
| 73 | </listitem>
|
---|
| 74 | </itemizedlist>
|
---|
| 75 |
|
---|
| 76 | <bridgehead renderas="sect3">Folks Dependencies</bridgehead>
|
---|
| 77 |
|
---|
| 78 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
| 79 | <para role="required">
|
---|
| 80 | <xref linkend="evolution-data-server"/>,
|
---|
| 81 | <xref linkend="gobject-introspection"/>,
|
---|
[41ccfd2] | 82 | <xref linkend="libgee"/>,
|
---|
| 83 | <!-- one file "tests/tools/manager-file.py" is still P2 -->
|
---|
| 84 | <xref linkend="python2"/> (during the build), and
|
---|
[36bbe491] | 85 | <xref linkend="telepathy-glib"/>
|
---|
| 86 | </para>
|
---|
| 87 |
|
---|
| 88 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
---|
| 89 | <para role="recommended">
|
---|
[60ddbaf] | 90 | <xref linkend="bluez"/> and
|
---|
[36bbe491] | 91 | <xref linkend="vala"/>
|
---|
| 92 | </para>
|
---|
| 93 |
|
---|
| 94 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
| 95 | <para role="optional">
|
---|
[dcea4e3] | 96 | <xref linkend="tracker"/> (Broken due to API changes in tracker),
|
---|
[36bbe491] | 97 | <ulink url="&gnome-download-http;/libsocialweb/">libsocialweb</ulink>, and
|
---|
[4538f99] | 98 | <ulink url="https://packages.debian.org/jessie/zeitgeist">Zeitgeist</ulink>
|
---|
[36bbe491] | 99 | </para>
|
---|
| 100 |
|
---|
| 101 | <para condition="html" role="usernotes">User Notes:
|
---|
| 102 | <ulink url="&blfs-wiki;/folks"/>
|
---|
| 103 | </para>
|
---|
| 104 | </sect2>
|
---|
| 105 |
|
---|
| 106 | <sect2 role="installation">
|
---|
| 107 | <title>Installation of Folks</title>
|
---|
| 108 |
|
---|
| 109 | <para>
|
---|
| 110 | Install <application>Folks</application> by running the following
|
---|
| 111 | commands:
|
---|
| 112 | </para>
|
---|
| 113 |
|
---|
[dcea4e3] | 114 | <screen><userinput>mkdir build &&
|
---|
| 115 | cd build &&
|
---|
| 116 |
|
---|
| 117 | meson --prefix=/usr --sysconfdir=/etc .. &&
|
---|
| 118 | ninja</userinput></screen>
|
---|
[36bbe491] | 119 |
|
---|
| 120 | <para>
|
---|
[dcea4e3] | 121 | To test the results, issue <command>ninja test</command> from a local
|
---|
[36bbe491] | 122 | X session started with <command>dbus-launch</command>.
|
---|
[dcea4e3] | 123 | <!-- In the future, we need to run the tests with Tracker's backend
|
---|
| 124 | enabled before we suggest enabling that backend. I tried this with 0.12.1
|
---|
| 125 | and had 103 test failures in Tracker's section of the test suite.
|
---|
| 126 | This is unacceptable and is why we have it disabled by default. -->
|
---|
[36bbe491] | 127 | </para>
|
---|
| 128 |
|
---|
| 129 | <para>
|
---|
| 130 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 131 | </para>
|
---|
| 132 |
|
---|
[dcea4e3] | 133 | <screen role="root"><userinput>ninja install</userinput></screen>
|
---|
[36bbe491] | 134 |
|
---|
| 135 | </sect2>
|
---|
| 136 |
|
---|
| 137 | <sect2 role="commands">
|
---|
| 138 | <title>Command Explanations</title>
|
---|
| 139 |
|
---|
| 140 | <para>
|
---|
[dcea4e3] | 141 | <option>-Dtracker_backend=true</option>: This switch enables
|
---|
[f277301f] | 142 | building the <application>Tracker</application> backend.
|
---|
[dcea4e3] | 143 | Use it if you have <application>Tracker</application> installed. This
|
---|
| 144 | functionality is current broken, however, due to an upstream API change
|
---|
| 145 | in Tracker that hasn't been accounted for in this package.
|
---|
[36bbe491] | 146 | </para>
|
---|
| 147 |
|
---|
| 148 | <para>
|
---|
[dcea4e3] | 149 | <option>-Ddocs=true</option>: This switch enables
|
---|
[36bbe491] | 150 | documentation generation.
|
---|
| 151 | </para>
|
---|
| 152 |
|
---|
| 153 | </sect2>
|
---|
| 154 |
|
---|
| 155 | <sect2 role="content">
|
---|
| 156 | <title>Contents</title>
|
---|
| 157 |
|
---|
| 158 | <segmentedlist>
|
---|
| 159 | <segtitle>Installed Programs</segtitle>
|
---|
| 160 | <segtitle>Installed Libraries</segtitle>
|
---|
| 161 | <segtitle>Installed Directories</segtitle>
|
---|
| 162 |
|
---|
| 163 | <seglistitem>
|
---|
| 164 | <seg>
|
---|
| 165 | folks-import and folks-inspect
|
---|
| 166 | </seg>
|
---|
| 167 | <seg>
|
---|
| 168 | libfolks-dummy.so, libfolks-eds.so, libfolks.so, and
|
---|
| 169 | libfolks-telepathy.so
|
---|
| 170 | </seg>
|
---|
| 171 | <seg>
|
---|
| 172 | /usr/include/folks and
|
---|
| 173 | /usr/lib/folks
|
---|
| 174 | </seg>
|
---|
| 175 | </seglistitem>
|
---|
| 176 | </segmentedlist>
|
---|
| 177 |
|
---|
| 178 | <variablelist>
|
---|
| 179 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 180 | <?dbfo list-presentation="list"?>
|
---|
| 181 | <?dbhtml list-presentation="table"?>
|
---|
| 182 |
|
---|
| 183 | <varlistentry id="folks-import">
|
---|
| 184 | <term><command>folks-import</command></term>
|
---|
| 185 | <listitem>
|
---|
| 186 | <para>
|
---|
| 187 | is used to import meta-contact information to libfolks.
|
---|
| 188 | </para>
|
---|
| 189 | <indexterm zone="folks folks-import">
|
---|
| 190 | <primary sortas="b-folks-import">folks-import</primary>
|
---|
| 191 | </indexterm>
|
---|
| 192 | </listitem>
|
---|
| 193 | </varlistentry>
|
---|
| 194 |
|
---|
| 195 | <varlistentry id="folks-inspect">
|
---|
| 196 | <term><command>folks-inspect</command></term>
|
---|
| 197 | <listitem>
|
---|
| 198 | <para>
|
---|
| 199 | is used to inspect meta-contact information in libfolks.
|
---|
| 200 | </para>
|
---|
| 201 | <indexterm zone="folks folks-inspect">
|
---|
| 202 | <primary sortas="b-folks-inspect">folks-inspect</primary>
|
---|
| 203 | </indexterm>
|
---|
| 204 | </listitem>
|
---|
| 205 | </varlistentry>
|
---|
| 206 |
|
---|
| 207 | <varlistentry id="libfolks-eds">
|
---|
| 208 | <term><filename class="libraryfile">libfolks-eds.so</filename></term>
|
---|
| 209 | <listitem>
|
---|
| 210 | <para>
|
---|
| 211 | contains Evolution specific implementations of the libfolks classes.
|
---|
| 212 | </para>
|
---|
| 213 | <indexterm zone="folks libfolks-eds">
|
---|
| 214 | <primary sortas="c-libfolks-eds">libfolks-eds.so</primary>
|
---|
| 215 | </indexterm>
|
---|
| 216 | </listitem>
|
---|
| 217 | </varlistentry>
|
---|
| 218 |
|
---|
[4538f99] | 219 | <!--
|
---|
[36bbe491] | 220 | <varlistentry id="libfolks-libsocialweb">
|
---|
| 221 | <term><filename class="libraryfile">libfolks-libsocialweb.so</filename></term>
|
---|
| 222 | <listitem>
|
---|
| 223 | <para>
|
---|
| 224 | contains libsocialweb specific implementations of the libfolks classes.
|
---|
| 225 | </para>
|
---|
| 226 | <indexterm zone="folks libfolks-libsocialweb">
|
---|
| 227 | <primary sortas="c-libfolks-libsocialweb">libfolks-libsocialweb.so</primary>
|
---|
| 228 | </indexterm>
|
---|
| 229 | </listitem>
|
---|
| 230 | </varlistentry>
|
---|
[4538f99] | 231 | -->
|
---|
[36bbe491] | 232 |
|
---|
| 233 | <varlistentry id="libfolks">
|
---|
| 234 | <term><filename class="libraryfile">libfolks.so</filename></term>
|
---|
| 235 | <listitem>
|
---|
| 236 | <para>
|
---|
| 237 | contains the <application>Folks</application> API functions.
|
---|
| 238 | </para>
|
---|
| 239 | <indexterm zone="folks libfolks">
|
---|
| 240 | <primary sortas="c-libfolks">libfolks.so</primary>
|
---|
| 241 | </indexterm>
|
---|
| 242 | </listitem>
|
---|
| 243 | </varlistentry>
|
---|
| 244 |
|
---|
| 245 | <varlistentry id="libfolks-telepathy">
|
---|
| 246 | <term><filename class="libraryfile">libfolks-telepathy.so</filename></term>
|
---|
| 247 | <listitem>
|
---|
| 248 | <para>
|
---|
| 249 | contains Telepathy specific implementations of the libfolks classes.
|
---|
| 250 | </para>
|
---|
| 251 | <indexterm zone="folks libfolks-telepathy">
|
---|
| 252 | <primary sortas="c-libfolks-telepathy">libfolks-telepathy.so</primary>
|
---|
| 253 | </indexterm>
|
---|
| 254 | </listitem>
|
---|
| 255 | </varlistentry>
|
---|
[dcea4e3] | 256 | <!--
|
---|
[36bbe491] | 257 | <varlistentry id="libfolks-tracker">
|
---|
| 258 | <term><filename class="libraryfile">libfolks-tracker.so</filename></term>
|
---|
| 259 | <listitem>
|
---|
| 260 | <para>
|
---|
| 261 | contains Tracker specific implementations of the libfolks classes.
|
---|
| 262 | </para>
|
---|
| 263 | <indexterm zone="folks libfolks-tracker">
|
---|
| 264 | <primary sortas="c-libfolks-tracker">libfolks-tracker.so</primary>
|
---|
| 265 | </indexterm>
|
---|
| 266 | </listitem>
|
---|
| 267 | </varlistentry>
|
---|
[dcea4e3] | 268 | -->
|
---|
[36bbe491] | 269 |
|
---|
| 270 | </variablelist>
|
---|
| 271 |
|
---|
| 272 | </sect2>
|
---|
| 273 |
|
---|
| 274 | </sect1>
|
---|