[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 |
|
---|
[e7a0ebd] | 7 | <!ENTITY folks-download-http "&gnome-download-http;/folks/0.14/folks-&folks-version;.tar.xz">
|
---|
| 8 | <!ENTITY folks-download-ftp "&gnome-download-ftp;/folks/0.14/folks-&folks-version;.tar.xz">
|
---|
| 9 | <!ENTITY folks-md5sum "dc852fceab9e84362b675d5ffcd4803e">
|
---|
[10092cde] | 10 | <!ENTITY folks-size "512 KB">
|
---|
[e7a0ebd] | 11 | <!ENTITY folks-buildsize "50 MB (add 19 MB for tests)">
|
---|
| 12 | <!ENTITY folks-time "0.2 SBU (Using parallelism=4, add 1.0 SBU for tests)">
|
---|
[36bbe491] | 13 | ]>
|
---|
| 14 |
|
---|
[51dfb3e] | 15 | <sect1 id="folks" xreflabel="Folks-&folks-version;">
|
---|
[36bbe491] | 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
|
---|
[44621c7] | 36 | <application>Evolution Data Server</application>,
|
---|
[36bbe491] | 37 | Facebook, etc.) to create metacontacts.
|
---|
| 38 | </para>
|
---|
| 39 |
|
---|
[88377804] | 40 | &lfs10_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"/>,
|
---|
[10092cde] | 83 | <xref linkend="python-dbusmock"/>, and
|
---|
[36bbe491] | 84 | <xref linkend="telepathy-glib"/>
|
---|
| 85 | </para>
|
---|
| 86 |
|
---|
| 87 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
---|
| 88 | <para role="recommended">
|
---|
[60ddbaf] | 89 | <xref linkend="bluez"/> and
|
---|
[36bbe491] | 90 | <xref linkend="vala"/>
|
---|
| 91 | </para>
|
---|
| 92 |
|
---|
| 93 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
| 94 | <para role="optional">
|
---|
[dcea4e3] | 95 | <xref linkend="tracker"/> (Broken due to API changes in tracker),
|
---|
[36bbe491] | 96 | <ulink url="&gnome-download-http;/libsocialweb/">libsocialweb</ulink>, and
|
---|
[4538f99] | 97 | <ulink url="https://packages.debian.org/jessie/zeitgeist">Zeitgeist</ulink>
|
---|
[36bbe491] | 98 | </para>
|
---|
| 99 |
|
---|
| 100 | <para condition="html" role="usernotes">User Notes:
|
---|
| 101 | <ulink url="&blfs-wiki;/folks"/>
|
---|
| 102 | </para>
|
---|
| 103 | </sect2>
|
---|
| 104 |
|
---|
| 105 | <sect2 role="installation">
|
---|
| 106 | <title>Installation of Folks</title>
|
---|
| 107 |
|
---|
| 108 | <para>
|
---|
| 109 | Install <application>Folks</application> by running the following
|
---|
| 110 | commands:
|
---|
| 111 | </para>
|
---|
| 112 |
|
---|
[dcea4e3] | 113 | <screen><userinput>mkdir build &&
|
---|
[bb8b4003] | 114 | cd build &&
|
---|
[dcea4e3] | 115 |
|
---|
[19613b0] | 116 | meson --prefix=/usr .. &&
|
---|
[dcea4e3] | 117 | ninja</userinput></screen>
|
---|
[36bbe491] | 118 |
|
---|
| 119 | <para>
|
---|
[dcea4e3] | 120 | To test the results, issue <command>ninja test</command> from a local
|
---|
[36bbe491] | 121 | X session started with <command>dbus-launch</command>.
|
---|
[44621c7] | 122 | </para>
|
---|
| 123 | <!--
|
---|
[5d314e0] | 124 | As of version 0.13.1, I just get 'No tests defined. - Bruce
|
---|
| 125 | -->
|
---|
[44621c7] | 126 | <!-- with 0.13.2, I get the following results:
|
---|
| 127 | Ok: 44
|
---|
| 128 | Expected Fail: 0
|
---|
| 129 | Fail: 0
|
---|
| 130 | Unexpected Pass: 0
|
---|
| 131 | Skipped: 0
|
---|
| 132 | Timeout: 0
|
---|
| 133 | I believe it now has the test suite again. -->
|
---|
| 134 |
|
---|
[dcea4e3] | 135 | <!-- In the future, we need to run the tests with Tracker's backend
|
---|
| 136 | enabled before we suggest enabling that backend. I tried this with 0.12.1
|
---|
| 137 | and had 103 test failures in Tracker's section of the test suite.
|
---|
| 138 | This is unacceptable and is why we have it disabled by default. -->
|
---|
[82192a18] | 139 | <!--
|
---|
| 140 | <para>
|
---|
| 141 | This package does not come with a test suite.
|
---|
| 142 | </para>
|
---|
| 143 | -->
|
---|
[36bbe491] | 144 | <para>
|
---|
| 145 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 146 | </para>
|
---|
| 147 |
|
---|
[dcea4e3] | 148 | <screen role="root"><userinput>ninja install</userinput></screen>
|
---|
[36bbe491] | 149 |
|
---|
| 150 | </sect2>
|
---|
| 151 |
|
---|
| 152 | <sect2 role="commands">
|
---|
| 153 | <title>Command Explanations</title>
|
---|
| 154 |
|
---|
| 155 | <para>
|
---|
[dcea4e3] | 156 | <option>-Dtracker_backend=true</option>: This switch enables
|
---|
[f277301f] | 157 | building the <application>Tracker</application> backend.
|
---|
[dcea4e3] | 158 | Use it if you have <application>Tracker</application> installed. This
|
---|
| 159 | functionality is current broken, however, due to an upstream API change
|
---|
| 160 | in Tracker that hasn't been accounted for in this package.
|
---|
[36bbe491] | 161 | </para>
|
---|
| 162 |
|
---|
| 163 | <para>
|
---|
[dcea4e3] | 164 | <option>-Ddocs=true</option>: This switch enables
|
---|
[36bbe491] | 165 | documentation generation.
|
---|
| 166 | </para>
|
---|
| 167 |
|
---|
| 168 | </sect2>
|
---|
| 169 |
|
---|
| 170 | <sect2 role="content">
|
---|
| 171 | <title>Contents</title>
|
---|
| 172 |
|
---|
| 173 | <segmentedlist>
|
---|
| 174 | <segtitle>Installed Programs</segtitle>
|
---|
| 175 | <segtitle>Installed Libraries</segtitle>
|
---|
| 176 | <segtitle>Installed Directories</segtitle>
|
---|
| 177 |
|
---|
| 178 | <seglistitem>
|
---|
| 179 | <seg>
|
---|
| 180 | folks-import and folks-inspect
|
---|
| 181 | </seg>
|
---|
| 182 | <seg>
|
---|
| 183 | libfolks-dummy.so, libfolks-eds.so, libfolks.so, and
|
---|
| 184 | libfolks-telepathy.so
|
---|
| 185 | </seg>
|
---|
| 186 | <seg>
|
---|
| 187 | /usr/include/folks and
|
---|
| 188 | /usr/lib/folks
|
---|
| 189 | </seg>
|
---|
| 190 | </seglistitem>
|
---|
| 191 | </segmentedlist>
|
---|
| 192 |
|
---|
| 193 | <variablelist>
|
---|
| 194 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 195 | <?dbfo list-presentation="list"?>
|
---|
| 196 | <?dbhtml list-presentation="table"?>
|
---|
| 197 |
|
---|
| 198 | <varlistentry id="folks-import">
|
---|
| 199 | <term><command>folks-import</command></term>
|
---|
| 200 | <listitem>
|
---|
| 201 | <para>
|
---|
| 202 | is used to import meta-contact information to libfolks.
|
---|
| 203 | </para>
|
---|
| 204 | <indexterm zone="folks folks-import">
|
---|
| 205 | <primary sortas="b-folks-import">folks-import</primary>
|
---|
| 206 | </indexterm>
|
---|
| 207 | </listitem>
|
---|
| 208 | </varlistentry>
|
---|
| 209 |
|
---|
| 210 | <varlistentry id="folks-inspect">
|
---|
| 211 | <term><command>folks-inspect</command></term>
|
---|
| 212 | <listitem>
|
---|
| 213 | <para>
|
---|
| 214 | is used to inspect meta-contact information in libfolks.
|
---|
| 215 | </para>
|
---|
| 216 | <indexterm zone="folks folks-inspect">
|
---|
| 217 | <primary sortas="b-folks-inspect">folks-inspect</primary>
|
---|
| 218 | </indexterm>
|
---|
| 219 | </listitem>
|
---|
| 220 | </varlistentry>
|
---|
| 221 |
|
---|
| 222 | <varlistentry id="libfolks-eds">
|
---|
| 223 | <term><filename class="libraryfile">libfolks-eds.so</filename></term>
|
---|
| 224 | <listitem>
|
---|
| 225 | <para>
|
---|
| 226 | contains Evolution specific implementations of the libfolks classes.
|
---|
| 227 | </para>
|
---|
| 228 | <indexterm zone="folks libfolks-eds">
|
---|
| 229 | <primary sortas="c-libfolks-eds">libfolks-eds.so</primary>
|
---|
| 230 | </indexterm>
|
---|
| 231 | </listitem>
|
---|
| 232 | </varlistentry>
|
---|
| 233 |
|
---|
[4538f99] | 234 | <!--
|
---|
[36bbe491] | 235 | <varlistentry id="libfolks-libsocialweb">
|
---|
| 236 | <term><filename class="libraryfile">libfolks-libsocialweb.so</filename></term>
|
---|
| 237 | <listitem>
|
---|
| 238 | <para>
|
---|
| 239 | contains libsocialweb specific implementations of the libfolks classes.
|
---|
| 240 | </para>
|
---|
| 241 | <indexterm zone="folks libfolks-libsocialweb">
|
---|
| 242 | <primary sortas="c-libfolks-libsocialweb">libfolks-libsocialweb.so</primary>
|
---|
| 243 | </indexterm>
|
---|
| 244 | </listitem>
|
---|
| 245 | </varlistentry>
|
---|
[4538f99] | 246 | -->
|
---|
[36bbe491] | 247 |
|
---|
| 248 | <varlistentry id="libfolks">
|
---|
| 249 | <term><filename class="libraryfile">libfolks.so</filename></term>
|
---|
| 250 | <listitem>
|
---|
| 251 | <para>
|
---|
| 252 | contains the <application>Folks</application> API functions.
|
---|
| 253 | </para>
|
---|
| 254 | <indexterm zone="folks libfolks">
|
---|
| 255 | <primary sortas="c-libfolks">libfolks.so</primary>
|
---|
| 256 | </indexterm>
|
---|
| 257 | </listitem>
|
---|
| 258 | </varlistentry>
|
---|
| 259 |
|
---|
| 260 | <varlistentry id="libfolks-telepathy">
|
---|
| 261 | <term><filename class="libraryfile">libfolks-telepathy.so</filename></term>
|
---|
| 262 | <listitem>
|
---|
| 263 | <para>
|
---|
| 264 | contains Telepathy specific implementations of the libfolks classes.
|
---|
| 265 | </para>
|
---|
| 266 | <indexterm zone="folks libfolks-telepathy">
|
---|
| 267 | <primary sortas="c-libfolks-telepathy">libfolks-telepathy.so</primary>
|
---|
| 268 | </indexterm>
|
---|
| 269 | </listitem>
|
---|
| 270 | </varlistentry>
|
---|
[dcea4e3] | 271 | <!--
|
---|
[36bbe491] | 272 | <varlistentry id="libfolks-tracker">
|
---|
| 273 | <term><filename class="libraryfile">libfolks-tracker.so</filename></term>
|
---|
| 274 | <listitem>
|
---|
| 275 | <para>
|
---|
| 276 | contains Tracker specific implementations of the libfolks classes.
|
---|
| 277 | </para>
|
---|
| 278 | <indexterm zone="folks libfolks-tracker">
|
---|
| 279 | <primary sortas="c-libfolks-tracker">libfolks-tracker.so</primary>
|
---|
| 280 | </indexterm>
|
---|
| 281 | </listitem>
|
---|
| 282 | </varlistentry>
|
---|
[dcea4e3] | 283 | -->
|
---|
[36bbe491] | 284 |
|
---|
| 285 | </variablelist>
|
---|
| 286 |
|
---|
| 287 | </sect2>
|
---|
| 288 |
|
---|
| 289 | </sect1>
|
---|