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.6/folks-&folks-version;.tar.bz2">
|
---|
8 | <!ENTITY folks-download-ftp "&gnome-download-ftp;/folks/0.6/folks-&folks-version;.tar.bz2">
|
---|
9 | <!ENTITY folks-md5sum "05c3a353bdaccf1f7bdf9fce97aba1e6">
|
---|
10 | <!ENTITY folks-size "1.5 MB">
|
---|
11 | <!ENTITY folks-buildsize "53 MB">
|
---|
12 | <!ENTITY folks-time "0.7 SBU">
|
---|
13 | ]>
|
---|
14 |
|
---|
15 | <sect1 id="folks" xreflabel="Folks-&folks-version;">
|
---|
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>The <application>Folks</application> package is a library that
|
---|
33 | aggregates people from multiple sources (eg,
|
---|
34 | <application>Telepathy</application> connection managers and eventually
|
---|
35 | <application>evolution data server</application>, Facebook, etc.) to create
|
---|
36 | metacontacts.</para>
|
---|
37 |
|
---|
38 | &lfs70_built;
|
---|
39 |
|
---|
40 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
41 | <itemizedlist spacing="compact">
|
---|
42 | <listitem>
|
---|
43 | <para>Download (HTTP): <ulink url="&folks-download-http;"/></para>
|
---|
44 | </listitem>
|
---|
45 | <listitem>
|
---|
46 | <para>Download (FTP): <ulink url="&folks-download-ftp;"/></para>
|
---|
47 | </listitem>
|
---|
48 | <listitem>
|
---|
49 | <para>Download MD5 sum: &folks-md5sum;</para>
|
---|
50 | </listitem>
|
---|
51 | <listitem>
|
---|
52 | <para>Download size: &folks-size;</para>
|
---|
53 | </listitem>
|
---|
54 | <listitem>
|
---|
55 | <para>Estimated disk space required: &folks-buildsize;</para>
|
---|
56 | </listitem>
|
---|
57 | <listitem>
|
---|
58 | <para>Estimated build time: &folks-time;</para>
|
---|
59 | </listitem>
|
---|
60 | </itemizedlist>
|
---|
61 |
|
---|
62 | <bridgehead renderas="sect3">Folks Dependencies</bridgehead>
|
---|
63 |
|
---|
64 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
65 | <para role="required"><xref linkend="intltool"/>,
|
---|
66 | <xref linkend="libgee"/>, and
|
---|
67 | <xref linkend="telepathy-glib"/></para>
|
---|
68 |
|
---|
69 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
70 | <para role="optional"><xref linkend="vala"/> and <ulink
|
---|
71 | url="http://live.gnome.org/Valadoc/">valadoc</ulink> (Required for
|
---|
72 | generating the documentation)</para>
|
---|
73 |
|
---|
74 | <para condition="html" role="usernotes">User Notes:
|
---|
75 | <ulink url="&blfs-wiki;/folks"/></para>
|
---|
76 |
|
---|
77 | </sect2>
|
---|
78 |
|
---|
79 | <sect2 role="installation">
|
---|
80 | <title>Installation of Folks</title>
|
---|
81 |
|
---|
82 | <para>Install <application>Folks</application> by running the following
|
---|
83 | commands:</para>
|
---|
84 |
|
---|
85 | <screen><userinput>./configure --prefix=/usr &&
|
---|
86 | make</userinput></screen>
|
---|
87 |
|
---|
88 | <para>To test the results, issue: <command>make check</command>.</para>
|
---|
89 |
|
---|
90 | <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
|
---|
91 |
|
---|
92 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
93 |
|
---|
94 | </sect2>
|
---|
95 |
|
---|
96 | <sect2 role="commands">
|
---|
97 | <title>Command Explanations</title>
|
---|
98 |
|
---|
99 | <para><parameter>--enable-vala</parameter>: This parameter enables building
|
---|
100 | from the Vala sources.</para>
|
---|
101 |
|
---|
102 | <para><parameter>--enable-docs</parameter>: This parameter enables
|
---|
103 | documentation generation.</para>
|
---|
104 |
|
---|
105 | </sect2>
|
---|
106 |
|
---|
107 | <sect2 role="content">
|
---|
108 | <title>Contents</title>
|
---|
109 |
|
---|
110 | <segmentedlist>
|
---|
111 | <segtitle>Installed Program</segtitle>
|
---|
112 | <segtitle>Installed Libraries</segtitle>
|
---|
113 | <segtitle>Installed Directories</segtitle>
|
---|
114 |
|
---|
115 | <seglistitem>
|
---|
116 | <seg>folks-import</seg>
|
---|
117 | <seg>libfolks-backend-key-file.so,libfolks-backend-telepathy.so,
|
---|
118 | libfolks-telepathy.so, and libfolks.so</seg>
|
---|
119 | <seg>/usr/{include/folks,lib/folks/22/backends/{key-file,
|
---|
120 | telepathy}}</seg>
|
---|
121 | </seglistitem>
|
---|
122 | </segmentedlist>
|
---|
123 |
|
---|
124 | <variablelist>
|
---|
125 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
126 | <?dbfo list-presentation="list"?>
|
---|
127 | <?dbhtml list-presentation="table"?>
|
---|
128 |
|
---|
129 | <varlistentry id="folks-import">
|
---|
130 | <term><command>folks-import</command></term>
|
---|
131 | <listitem>
|
---|
132 | <para>is a tool to import meta-contact data from
|
---|
133 | <application>Pidgin</application>.</para>
|
---|
134 | <indexterm zone="folks folks-import">
|
---|
135 | <primary sortas="b-folks-import">folks-import</primary>
|
---|
136 | </indexterm>
|
---|
137 | </listitem>
|
---|
138 | </varlistentry>
|
---|
139 |
|
---|
140 | <!-- <varlistentry id="libfolks-backend-key-file">
|
---|
141 | <term><filename class='libraryfile'>libfolks-backend-key-file.so</filename></term>
|
---|
142 | <listitem>
|
---|
143 | <para>contains functions that .....</para>
|
---|
144 | <indexterm zone="folks libfolks-backend-key-file">
|
---|
145 | <primary sortas="c-libfolks-backend-key-file">libfolks-backend-key-file.so</primary>
|
---|
146 | </indexterm>
|
---|
147 | </listitem>
|
---|
148 | </varlistentry> -->
|
---|
149 |
|
---|
150 | <varlistentry id="libfolks-backend-telepathy">
|
---|
151 | <term><filename class='libraryfile'>libfolks-backend-telepathy.so</filename></term>
|
---|
152 | <listitem>
|
---|
153 | <para>contains functions for the <application>Telepathy</application>
|
---|
154 | backend.</para>
|
---|
155 | <indexterm zone="folks libfolks-backend-telepathy">
|
---|
156 | <primary sortas="c-libfolks-backend-telepathy">libfolks-backend-telepathy.so</primary>
|
---|
157 | </indexterm>
|
---|
158 | </listitem>
|
---|
159 | </varlistentry>
|
---|
160 |
|
---|
161 | <varlistentry id="libfolks-telepathy">
|
---|
162 | <term><filename class='libraryfile'>libfolks-telepathy.so</filename></term>
|
---|
163 | <listitem>
|
---|
164 | <para>contains Telepathy-specific implementations of the libfolks
|
---|
165 | classes.</para>
|
---|
166 | <indexterm zone="folks libfolks-telepathy">
|
---|
167 | <primary sortas="c-libfolks-telepathy">libfolks-telepathy.so</primary>
|
---|
168 | </indexterm>
|
---|
169 | </listitem>
|
---|
170 | </varlistentry>
|
---|
171 |
|
---|
172 | <varlistentry id="libfolks">
|
---|
173 | <term><filename class='libraryfile'>libfolks.so</filename></term>
|
---|
174 | <listitem>
|
---|
175 | <para>contains the folks API functions.</para>
|
---|
176 | <indexterm zone="folks libfolks">
|
---|
177 | <primary sortas="c-libfolks">libfolks.so</primary>
|
---|
178 | </indexterm>
|
---|
179 | </listitem>
|
---|
180 | </varlistentry>
|
---|
181 |
|
---|
182 | </variablelist>
|
---|
183 |
|
---|
184 | </sect2>
|
---|
185 |
|
---|
186 | </sect1>
|
---|