| 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 |
|
|---|
| 7 | <!ENTITY folks-download-http "&gnome-download-http;/folks/0.15/folks-&folks-version;.tar.xz">
|
|---|
| 8 | <!ENTITY folks-download-ftp "&gnome-download-ftp;/folks/0.15/folks-&folks-version;.tar.xz">
|
|---|
| 9 | <!ENTITY folks-md5sum "84757a41d6842a6f8f5401c14def4832">
|
|---|
| 10 | <!ENTITY folks-size "481 KB">
|
|---|
| 11 | <!ENTITY folks-buildsize "33 MB (add 23 MB for tests)">
|
|---|
| 12 | <!ENTITY folks-time "0.2 SBU (Using parallelism=4, add 0.3 SBU for tests)">
|
|---|
| 13 | ]>
|
|---|
| 14 |
|
|---|
| 15 | <sect1 id="folks" xreflabel="Folks-&folks-version;">
|
|---|
| 16 | <?dbhtml filename="folks.html"?>
|
|---|
| 17 |
|
|---|
| 18 | <sect1info>
|
|---|
| 19 | <date>$Date$</date>
|
|---|
| 20 | </sect1info>
|
|---|
| 21 |
|
|---|
| 22 | <title>Folks-&folks-version;</title>
|
|---|
| 23 |
|
|---|
| 24 | <indexterm zone="folks">
|
|---|
| 25 | <primary sortas="a-Folks">Folks</primary>
|
|---|
| 26 | </indexterm>
|
|---|
| 27 |
|
|---|
| 28 | <sect2 role="package">
|
|---|
| 29 | <title>Introduction to Folks</title>
|
|---|
| 30 |
|
|---|
| 31 | <para>
|
|---|
| 32 | <application>Folks</application> is a library that
|
|---|
| 33 | aggregates people from multiple sources (e.g,
|
|---|
| 34 | <application>Telepathy</application> connection managers and
|
|---|
| 35 | <application>Evolution Data Server</application>,
|
|---|
| 36 | Facebook, etc.) to create metacontacts.
|
|---|
| 37 | </para>
|
|---|
| 38 |
|
|---|
| 39 | &lfs110a_checked;
|
|---|
| 40 |
|
|---|
| 41 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
|---|
| 42 | <itemizedlist spacing="compact">
|
|---|
| 43 | <listitem>
|
|---|
| 44 | <para>
|
|---|
| 45 | Download (HTTP): <ulink url="&folks-download-http;"/>
|
|---|
| 46 | </para>
|
|---|
| 47 | </listitem>
|
|---|
| 48 | <listitem>
|
|---|
| 49 | <para>
|
|---|
| 50 | Download (FTP): <ulink url="&folks-download-ftp;"/>
|
|---|
| 51 | </para>
|
|---|
| 52 | </listitem>
|
|---|
| 53 | <listitem>
|
|---|
| 54 | <para>
|
|---|
| 55 | Download MD5 sum: &folks-md5sum;
|
|---|
| 56 | </para>
|
|---|
| 57 | </listitem>
|
|---|
| 58 | <listitem>
|
|---|
| 59 | <para>
|
|---|
| 60 | Download size: &folks-size;
|
|---|
| 61 | </para>
|
|---|
| 62 | </listitem>
|
|---|
| 63 | <listitem>
|
|---|
| 64 | <para>
|
|---|
| 65 | Estimated disk space required: &folks-buildsize;
|
|---|
| 66 | </para>
|
|---|
| 67 | </listitem>
|
|---|
| 68 | <listitem>
|
|---|
| 69 | <para>
|
|---|
| 70 | Estimated build time: &folks-time;
|
|---|
| 71 | </para>
|
|---|
| 72 | </listitem>
|
|---|
| 73 | </itemizedlist>
|
|---|
| 74 |
|
|---|
| 75 | <bridgehead renderas="sect3">Folks Dependencies</bridgehead>
|
|---|
| 76 |
|
|---|
| 77 | <bridgehead renderas="sect4">Required</bridgehead>
|
|---|
| 78 | <para role="required">
|
|---|
| 79 | <xref linkend="evolution-data-server"/>,
|
|---|
| 80 | <xref linkend="gobject-introspection"/>,
|
|---|
| 81 | <xref linkend="libgee"/>,
|
|---|
| 82 | <xref linkend="python-dbusmock"/>, and
|
|---|
| 83 | <xref linkend="telepathy-glib"/>
|
|---|
| 84 | </para>
|
|---|
| 85 |
|
|---|
| 86 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
|---|
| 87 | <para role="recommended">
|
|---|
| 88 | <xref linkend="bluez"/> and
|
|---|
| 89 | <xref linkend="vala"/>
|
|---|
| 90 | </para>
|
|---|
| 91 |
|
|---|
| 92 | <bridgehead renderas="sect4">Optional</bridgehead>
|
|---|
| 93 | <para role="optional">
|
|---|
| 94 | <!--<xref linkend="tracker"/> (Broken due to API changes in tracker), -->
|
|---|
| 95 | <ulink url="&gnome-download-http;/libsocialweb/">libsocialweb</ulink> and
|
|---|
| 96 | <ulink url="https://packages.debian.org/jessie/zeitgeist">Zeitgeist</ulink>
|
|---|
| 97 | </para>
|
|---|
| 98 |
|
|---|
| 99 | <para condition="html" role="usernotes">User Notes:
|
|---|
| 100 | <ulink url="&blfs-wiki;/folks"/>
|
|---|
| 101 | </para>
|
|---|
| 102 | </sect2>
|
|---|
| 103 |
|
|---|
| 104 | <sect2 role="installation">
|
|---|
| 105 | <title>Installation of Folks</title>
|
|---|
| 106 |
|
|---|
| 107 | <para>
|
|---|
| 108 | Install <application>Folks</application> by running the following
|
|---|
| 109 | commands:
|
|---|
| 110 | </para>
|
|---|
| 111 |
|
|---|
| 112 | <screen><userinput>mkdir build &&
|
|---|
| 113 | cd build &&
|
|---|
| 114 |
|
|---|
| 115 | meson --prefix=/usr --buildtype=release .. &&
|
|---|
| 116 | ninja</userinput></screen>
|
|---|
| 117 |
|
|---|
| 118 | <para>
|
|---|
| 119 | To test the results, issue <command>ninja test</command> from a local
|
|---|
| 120 | X session started with <command>dbus-launch</command>. A few tests may
|
|---|
| 121 | time out.
|
|---|
| 122 | </para>
|
|---|
| 123 | <!--
|
|---|
| 124 | As of version 0.13.1, I just get 'No tests defined. - Bruce
|
|---|
| 125 | -->
|
|---|
| 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 |
|
|---|
| 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. -->
|
|---|
| 139 | <!--
|
|---|
| 140 | <para>
|
|---|
| 141 | This package does not come with a test suite.
|
|---|
| 142 | </para>
|
|---|
| 143 | -->
|
|---|
| 144 | <para>
|
|---|
| 145 | Now, as the <systemitem class="username">root</systemitem> user:
|
|---|
| 146 | </para>
|
|---|
| 147 |
|
|---|
| 148 | <screen role="root"><userinput>ninja install</userinput></screen>
|
|---|
| 149 |
|
|---|
| 150 | </sect2>
|
|---|
| 151 |
|
|---|
| 152 | <sect2 role="commands">
|
|---|
| 153 | <title>Command Explanations</title>
|
|---|
| 154 |
|
|---|
| 155 | <!-- Tracker support removed in 0.15.1
|
|---|
| 156 | <para>
|
|---|
| 157 | <option>-Dtracker_backend=true</option>: This switch enables
|
|---|
| 158 | building the <application>Tracker</application> backend.
|
|---|
| 159 | Use it if you have <application>Tracker</application> installed. This
|
|---|
| 160 | functionality is current broken, however, due to an upstream API change
|
|---|
| 161 | in Tracker that hasn't been accounted for in this package.
|
|---|
| 162 | </para>
|
|---|
| 163 | -->
|
|---|
| 164 |
|
|---|
| 165 | <para>
|
|---|
| 166 | <option>-Ddocs=true</option>: This switch enables
|
|---|
| 167 | documentation generation.
|
|---|
| 168 | </para>
|
|---|
| 169 |
|
|---|
| 170 | </sect2>
|
|---|
| 171 |
|
|---|
| 172 | <sect2 role="content">
|
|---|
| 173 | <title>Contents</title>
|
|---|
| 174 |
|
|---|
| 175 | <segmentedlist>
|
|---|
| 176 | <segtitle>Installed Programs</segtitle>
|
|---|
| 177 | <segtitle>Installed Libraries</segtitle>
|
|---|
| 178 | <segtitle>Installed Directories</segtitle>
|
|---|
| 179 |
|
|---|
| 180 | <seglistitem>
|
|---|
| 181 | <seg>
|
|---|
| 182 | folks-import and folks-inspect
|
|---|
| 183 | </seg>
|
|---|
| 184 | <seg>
|
|---|
| 185 | libfolks-dummy.so, libfolks-eds.so, libfolks.so, and
|
|---|
| 186 | libfolks-telepathy.so
|
|---|
| 187 | </seg>
|
|---|
| 188 | <seg>
|
|---|
| 189 | /usr/include/folks and
|
|---|
| 190 | /usr/lib/folks
|
|---|
| 191 | </seg>
|
|---|
| 192 | </seglistitem>
|
|---|
| 193 | </segmentedlist>
|
|---|
| 194 |
|
|---|
| 195 | <variablelist>
|
|---|
| 196 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
|---|
| 197 | <?dbfo list-presentation="list"?>
|
|---|
| 198 | <?dbhtml list-presentation="table"?>
|
|---|
| 199 |
|
|---|
| 200 | <varlistentry id="folks-import">
|
|---|
| 201 | <term><command>folks-import</command></term>
|
|---|
| 202 | <listitem>
|
|---|
| 203 | <para>
|
|---|
| 204 | is used to import meta-contact information to libfolks
|
|---|
| 205 | </para>
|
|---|
| 206 | <indexterm zone="folks folks-import">
|
|---|
| 207 | <primary sortas="b-folks-import">folks-import</primary>
|
|---|
| 208 | </indexterm>
|
|---|
| 209 | </listitem>
|
|---|
| 210 | </varlistentry>
|
|---|
| 211 |
|
|---|
| 212 | <varlistentry id="folks-inspect">
|
|---|
| 213 | <term><command>folks-inspect</command></term>
|
|---|
| 214 | <listitem>
|
|---|
| 215 | <para>
|
|---|
| 216 | is used to inspect meta-contact information in libfolks
|
|---|
| 217 | </para>
|
|---|
| 218 | <indexterm zone="folks folks-inspect">
|
|---|
| 219 | <primary sortas="b-folks-inspect">folks-inspect</primary>
|
|---|
| 220 | </indexterm>
|
|---|
| 221 | </listitem>
|
|---|
| 222 | </varlistentry>
|
|---|
| 223 |
|
|---|
| 224 | <varlistentry id="libfolks-eds">
|
|---|
| 225 | <term><filename class="libraryfile">libfolks-eds.so</filename></term>
|
|---|
| 226 | <listitem>
|
|---|
| 227 | <para>
|
|---|
| 228 | contains Evolution specific implementations of the libfolks classes
|
|---|
| 229 | </para>
|
|---|
| 230 | <indexterm zone="folks libfolks-eds">
|
|---|
| 231 | <primary sortas="c-libfolks-eds">libfolks-eds.so</primary>
|
|---|
| 232 | </indexterm>
|
|---|
| 233 | </listitem>
|
|---|
| 234 | </varlistentry>
|
|---|
| 235 |
|
|---|
| 236 | <!--
|
|---|
| 237 | <varlistentry id="libfolks-libsocialweb">
|
|---|
| 238 | <term><filename class="libraryfile">libfolks-libsocialweb.so</filename></term>
|
|---|
| 239 | <listitem>
|
|---|
| 240 | <para>
|
|---|
| 241 | contains libsocialweb specific implementations of the libfolks classes.
|
|---|
| 242 | </para>
|
|---|
| 243 | <indexterm zone="folks libfolks-libsocialweb">
|
|---|
| 244 | <primary sortas="c-libfolks-libsocialweb">libfolks-libsocialweb.so</primary>
|
|---|
| 245 | </indexterm>
|
|---|
| 246 | </listitem>
|
|---|
| 247 | </varlistentry>
|
|---|
| 248 | -->
|
|---|
| 249 |
|
|---|
| 250 | <varlistentry id="libfolks">
|
|---|
| 251 | <term><filename class="libraryfile">libfolks.so</filename></term>
|
|---|
| 252 | <listitem>
|
|---|
| 253 | <para>
|
|---|
| 254 | contains the <application>Folks</application> API functions
|
|---|
| 255 | </para>
|
|---|
| 256 | <indexterm zone="folks libfolks">
|
|---|
| 257 | <primary sortas="c-libfolks">libfolks.so</primary>
|
|---|
| 258 | </indexterm>
|
|---|
| 259 | </listitem>
|
|---|
| 260 | </varlistentry>
|
|---|
| 261 |
|
|---|
| 262 | <varlistentry id="libfolks-telepathy">
|
|---|
| 263 | <term><filename class="libraryfile">libfolks-telepathy.so</filename></term>
|
|---|
| 264 | <listitem>
|
|---|
| 265 | <para>
|
|---|
| 266 | contains Telepathy specific implementations of the libfolks classes
|
|---|
| 267 | </para>
|
|---|
| 268 | <indexterm zone="folks libfolks-telepathy">
|
|---|
| 269 | <primary sortas="c-libfolks-telepathy">libfolks-telepathy.so</primary>
|
|---|
| 270 | </indexterm>
|
|---|
| 271 | </listitem>
|
|---|
| 272 | </varlistentry>
|
|---|
| 273 | <!--
|
|---|
| 274 | <varlistentry id="libfolks-tracker">
|
|---|
| 275 | <term><filename class="libraryfile">libfolks-tracker.so</filename></term>
|
|---|
| 276 | <listitem>
|
|---|
| 277 | <para>
|
|---|
| 278 | contains Tracker specific implementations of the libfolks classes.
|
|---|
| 279 | </para>
|
|---|
| 280 | <indexterm zone="folks libfolks-tracker">
|
|---|
| 281 | <primary sortas="c-libfolks-tracker">libfolks-tracker.so</primary>
|
|---|
| 282 | </indexterm>
|
|---|
| 283 | </listitem>
|
|---|
| 284 | </varlistentry>
|
|---|
| 285 | -->
|
|---|
| 286 |
|
|---|
| 287 | </variablelist>
|
|---|
| 288 |
|
|---|
| 289 | </sect2>
|
|---|
| 290 |
|
|---|
| 291 | </sect1>
|
|---|
