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