source: xsoft/other/pidgin.xml@ 4c32ae7

12.1 ken/TL2024 ken/tuningfonts lazarus plabs/newcss python3.11 rahul/power-profiles-daemon renodr/vulkan-addition trunk xry111/llvm18
Last change on this file since 4c32ae7 was 1bf0fac, checked in by Bruce Dubbs <bdubbs@…>, 10 months ago

Tag all of xsoft except libreoffice

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