source: xsoft/other/pidgin.xml

trunk
Last change on this file was 85ea15e, checked in by Bruce Dubbs <bdubbs@…>, 2 months ago

Update to pidgin-2.14.13.

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