source: xsoft/other/pidgin.xml@ 39f5848

lazarus
Last change on this file since 39f5848 was 39f5848, checked in by Thomas Trepl (Moody) <thomas@…>, 8 months ago

Merge trunk

  • Property mode set to 100644
File size: 13.2 KB
Line 
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 pidgin-download-http "&sourceforge-dl;/pidgin/pidgin-&pidgin-version;.tar.bz2">
8 <!ENTITY pidgin-download-ftp " ">
9 <!ENTITY pidgin-md5sum "476d808a268c693adcc8fc5c952dadd4">
10 <!ENTITY pidgin-size "8.3 MB">
11 <!ENTITY pidgin-buildsize "302 MB (with tests and docs)">
12 <!ENTITY pidgin-time "0.6 SBU (using parallelism=4; with tests and docs)">
13]>
14
15<sect1 id="pidgin" xreflabel="Pidgin-&pidgin-version;">
16 <?dbhtml filename="pidgin.html"?>
17
18 <sect1info>
19 <date>$Date$</date>
20 </sect1info>
21
22 <title>Pidgin-&pidgin-version;</title>
23
24 <indexterm zone="pidgin">
25 <primary sortas="a-Pidgin">Pidgin</primary>
26 </indexterm>
27
28 <sect2 role="package">
29 <title>Introduction to Pidgin</title>
30
31 <para>
32 <application>Pidgin</application> is a Gtk+ 2 instant messaging client
33 that can connect with a wide range of networks including Bonjour, ICQ,
34 GroupWise, Jabber/XMPP, IRC, Gadu-Gadu, SILC, SIMPLE, and Zephyr.
35 </para>
36
37 &lfs110a_checked;
38
39 <bridgehead renderas="sect3">Package Information</bridgehead>
40 <itemizedlist spacing="compact">
41 <listitem>
42 <para>
43 Download (HTTP): <ulink url="&pidgin-download-http;"/>
44 </para>
45 </listitem>
46 <listitem>
47 <para>
48 Download (FTP): <ulink url="&pidgin-download-ftp;"/>
49 </para>
50 </listitem>
51 <listitem>
52 <para>
53 Download MD5 sum: &pidgin-md5sum;
54 </para>
55 </listitem>
56 <listitem>
57 <para>
58 Download size: &pidgin-size;
59 </para>
60 </listitem>
61 <listitem>
62 <para>
63 Estimated disk space required: &pidgin-buildsize;
64 </para>
65 </listitem>
66 <listitem>
67 <para>
68 Estimated build time: &pidgin-time;
69 </para>
70 </listitem>
71 </itemizedlist>
72
73 <bridgehead renderas="sect3">Additional Downloads</bridgehead>
74 <itemizedlist spacing="compact">
75 <listitem>
76 <para>
77 Required patch:
78 <ulink url="&patch-root;/pidgin-&pidgin-version;-fix_time_conv-1.patch"/>
79 </para>
80 </listitem>
81 </itemizedlist>
82
83
84 <bridgehead renderas="sect3">Pidgin Dependencies</bridgehead>
85
86 <bridgehead renderas="sect4">Required</bridgehead>
87 <para role="required">
88 <xref linkend="gtk2"/>
89 </para>
90
91 <bridgehead renderas="sect4">Recommended</bridgehead>
92 <para role="recommended">
93 <xref linkend="libgcrypt"/>,
94 <xref linkend="gstreamer10"/> (required for audio support), and
95 <xref linkend="gnutls"/> or
96 <xref role="nodep" linkend="nss"/>
97 </para>
98
99 <!--
100 <para>
101 SSL support is required for the MSN Messenger, Yahoo!, Novel Groupwise and
102 Google Talk protocol plugins. <application>GnuTLS</application> is the
103 preferred method (the Mozilla NSS API is more likely to change and this
104 can cause problems).
105 </para>
106 -->
107
108 <bridgehead renderas="sect4">Optional</bridgehead>
109 <para role="optional">
110 <xref linkend="avahi"/> (required for the Bonjour plugin),
111 <xref linkend="cyrus-sasl"/>,
112 <xref linkend="dbus"/>,
113 <xref linkend="doxygen"/>,
114 <xref linkend="evolution-data-server"/>,
115 <xref linkend="GConf"/>,
116 <xref linkend="graphviz"/>,
117 <xref linkend="libidn"/> (required, if you wish to run the test suite),
118 <xref linkend="libnsl"/>,
119 <xref linkend="NetworkManager"/>,
120 <xref linkend="sqlite"/> (required for the Contact Availability Prediction
121 plugin),
122 <xref linkend="startup-notification"/>,
123 <!-- <xref linkend="tcl"/>, -->
124 <xref linkend="tk"/>,
125 <ulink url="http://www.freedesktop.org/wiki/Software/Farstream">
126 Farstream (Version 0.1)</ulink>
127 (required for video and voice support),
128 <ulink url="http://gtkspell.sourceforge.net/">Gtkspell</ulink>,
129 <ulink url="http://libgadu.net/">libgadu</ulink>,
130 <ulink url="http://meanwhile.sourceforge.net/">Meanwhile</ulink>
131 (required for Sametime protocol support),
132 <ulink url="https://www.mono-project.com/">Mono</ulink>,
133 <ulink url="http://silcnet.org/client.html">SILC Client</ulink>,
134 <ulink url="http://silcnet.org/client.html">SILC Toolkit</ulink>,
135 <ulink url="http://packages.debian.org/stable/source/zephyr">Zephyr</ulink>, and
136 <xref linkend="mitkrb"/> (required for Kerberos support in the Zephyr
137 module)
138 </para>
139
140 <bridgehead renderas="sect4">Optional (runtime)</bridgehead>
141 <para role="optional">
142 <xref role="runtime" linkend="xdg-utils"/>
143 </para>
144
145 <para condition="html" role="usernotes">
146 User Notes: <ulink url="&blfs-wiki;/pidgin"/>
147 </para>
148 </sect2>
149
150 <sect2 role="installation">
151 <title>Installation of Pidgin</title>
152
153 <para>
154 First, apply a patch that fixes time to string conversions:
155 </para>
156
157<screen><userinput>patch -Np1 -i ../pidgin-&pidgin-version;-fix_time_conv-1.patch</userinput></screen>
158
159 <para>
160 Compile <application>Pidgin</application> by running the following
161 commands:
162 </para>
163
164<screen><userinput>./configure --prefix=/usr \
165 --sysconfdir=/etc \
166 --with-gstreamer=1.0 \
167 --disable-avahi \
168 --disable-gtkspell \
169 --disable-meanwhile \
170 --disable-idn \
171 --disable-nm \
172 --disable-vv &amp;&amp;
173make</userinput></screen>
174
175 <para>
176 If you have <xref linkend="doxygen"/> installed
177 (<xref linkend="graphviz"/> can be used also) and you wish to create the
178 API documentation, issue:
179 </para>
180
181<screen remap="doc"><userinput>make docs</userinput></screen>
182
183 <para>
184 To test the results, issue: <command>make check</command>.
185 </para>
186
187 <para>
188 Now, as the <systemitem class="username">root</systemitem> user:
189 </para>
190
191<screen role="root"><userinput>make install &amp;&amp;
192mkdir -pv /usr/share/doc/pidgin-&pidgin-version; &amp;&amp;
193cp -v README doc/gtkrc-2.0 /usr/share/doc/pidgin-&pidgin-version;</userinput></screen>
194
195 <para>
196 If you created the API documentation, install it using the following
197 commands as the <systemitem class="username">root</systemitem> user:
198 </para>
199
200<screen role="root"
201 remap="doc"><userinput>mkdir -pv /usr/share/doc/pidgin-&pidgin-version;/api &amp;&amp;
202cp -rv doc/html/* /usr/share/doc/pidgin-&pidgin-version;/api</userinput></screen>
203
204 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
205 href="../../xincludes/update-icons-and-desktop.xml"/>
206
207 </sect2>
208
209 <sect2 role="commands">
210 <title>Command Explanations</title>
211
212 <para>
213 <parameter>--with-gstreamer=1.0</parameter>: Remove this switch
214 and add <option>--disable-gstreamer</option>
215 if you've not installed <xref linkend="gstreamer10"/>.
216 </para>
217
218 <para>
219 <parameter>--disable-avahi</parameter>: Remove this switch if you've
220 installed <xref linkend="avahi"/>.
221 </para>
222
223 <para>
224 <parameter>--disable-gtkspell</parameter>: Remove this
225 switch if you've installed
226 <ulink url="http://gtkspell.sourceforge.net/">Gtkspell</ulink> and wish
227 to enable spellchecking support.
228 </para>
229
230 <para>
231 <parameter>--disable-meanwhile</parameter>: Remove this switch if you've
232 installed <ulink url="http://meanwhile.sourceforge.net/">Meanwhile</ulink>.
233 </para>
234
235 <para>
236 <parameter>--disable-idn</parameter>: Remove this switch if you've
237 installed <xref linkend="libidn"/>.
238 </para>
239
240 <para>
241 <parameter>--disable-nm</parameter>: Remove this switch if you've
242 installed <xref linkend="NetworkManager"/>.
243 </para>
244
245 <para>
246 <parameter>--disable-vv</parameter>: Remove this
247 switch if you've installed
248 <ulink url="http://www.freedesktop.org/wiki/Software/Farstream">
249 Farstream (Version 0.1)</ulink> and wish to enable voice and video
250 communication support. You should also remove the --disable-gstreamer
251 flag.
252 </para>
253
254 <para>
255 <option>--enable-cyrus-sasl</option>: Use this switch if you've installed
256 <xref linkend="cyrus-sasl"/> and wish to build
257 <application>Pidgin</application> with SASL support.
258 </para>
259
260 <para>
261 <option>--disable-gnutls</option>: Use this switch if you've got both
262 <xref linkend="gnutls"/> and <xref linkend="nss"/> installed, but want
263 to use <xref linkend="nss"/> for the SSL support.
264 </para>
265
266 </sect2>
267
268 <sect2 role="configuration">
269 <title>Configuring Pidgin</title>
270
271 <sect3 id="pidgin-config">
272 <title>Config Files</title>
273 <para>
274 <filename>~/.purple/*</filename> and
275 <filename>~/.gtkrc-2.0</filename>
276 </para>
277
278 <indexterm zone="pidgin pidgin-config">
279 <primary sortas="e-AA.purple-*">~/.purple/*</primary>
280 </indexterm>
281
282 <indexterm zone="pidgin pidgin-config">
283 <primary sortas="e-AA.gtkrc-20">~/.gtkrc-2.0</primary>
284 </indexterm>
285 </sect3>
286
287 <sect3><title>Configuration Information</title>
288
289 <para>
290 Most configuration can be accomplished by using the various preference
291 settings inside the programs. Additionally, you can create a
292 <filename>~/.gtkrc-2.0</filename> file which can store gtk+-2 theme
293 settings that affect <application>Pidgin</application> and other Gtk+ 2
294 applications. Note that an example <filename>gtkrc-2.0</filename> file
295 was installed during the package installation and can be used as a
296 starting point or reference.
297 </para>
298
299 </sect3>
300
301 </sect2>
302
303 <sect2 role="content">
304 <title>Contents</title>
305
306 <segmentedlist>
307 <segtitle>Installed Programs</segtitle>
308 <segtitle>Installed Library</segtitle>
309 <segtitle>Installed Directories</segtitle>
310
311 <seglistitem>
312 <seg>
313 pidgin, purple-client-example,
314 purple-remote, purple-send, purple-send-async, and
315 purple-url-handler
316 </seg>
317 <seg>
318 libpurple.so, and libpurple-client.so
319 </seg>
320 <seg>
321 /usr/include/libpurple,
322 /usr/include/pidgin,
323 /usr/lib/pidgin,
324 /usr/lib/purple-2,
325 /usr/share/doc/pidgin-&pidgin-version;,
326 /usr/share/pixmaps/pidgin,
327 /usr/share/purple, and
328 /usr/share/sounds/purple
329 </seg>
330 </seglistitem>
331 </segmentedlist>
332
333 <variablelist>
334 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
335 <?dbfo list-presentation="list"?>
336 <?dbhtml list-presentation="table"?>
337
338 <varlistentry id="pidgin-prog">
339 <term><command>pidgin</command></term>
340 <listitem>
341 <para>
342 is a <application>GTK+</application> 2 instant messaging client
343 </para>
344 <indexterm zone="pidgin pidgin-prog">
345 <primary sortas="b-pidgin">pidgin</primary>
346 </indexterm>
347 </listitem>
348 </varlistentry>
349
350 <varlistentry id="purple-client-example">
351 <term><command>purple-client-example</command></term>
352 <listitem>
353 <para>
354 is an example that demonstrates how to use the libpurple-client
355 library to communicate with purple
356 </para>
357 <indexterm zone="pidgin purple-client-example">
358 <primary sortas="b-purple-client-example">purple-client-example</primary>
359 </indexterm>
360 </listitem>
361 </varlistentry>
362
363 <varlistentry id="purple-remote">
364 <term><command>purple-remote</command></term>
365 <listitem>
366 <para>
367 sends remote commands to Pidgin/Finch
368 </para>
369 <indexterm zone="pidgin purple-remote">
370 <primary sortas="b-purple-remote">purple-remote</primary>
371 </indexterm>
372 </listitem>
373 </varlistentry>
374
375 <varlistentry id="purple-send">
376 <term><command>purple-send</command></term>
377 <listitem>
378 <para>
379 calls purple API functions using DBus and prints the return value
380 </para>
381 <indexterm zone="pidgin purple-send">
382 <primary sortas="b-purple-send">purple-send</primary>
383 </indexterm>
384 </listitem>
385 </varlistentry>
386
387 <varlistentry id="purple-send-async">
388 <term><command>purple-send-async</command></term>
389 <listitem>
390 <para>
391 calls purple API functions using DBus. As opposed to
392 <command>purple-send</command>, it does not print the return value
393 </para>
394 <indexterm zone="pidgin purple-send-async">
395 <primary sortas="b-purple-send-async">purple-send-async</primary>
396 </indexterm>
397 </listitem>
398 </varlistentry>
399
400 <varlistentry id="purple-url-handler">
401 <term><command>purple-url-handler</command></term>
402 <listitem>
403 <para>
404 is a python script to handle URLs with purple
405 </para>
406 <indexterm zone="pidgin purple-url-handler">
407 <primary sortas="b-purple-url-handler">purple-url-handler</primary>
408 </indexterm>
409 </listitem>
410 </varlistentry>
411
412 </variablelist>
413
414 </sect2>
415
416</sect1>
Note: See TracBrowser for help on using the repository browser.