README

Mon, 10 Sep 2007 23:19:34 +0000

author
Etan Reisner <deryni@pidgin.im>
date
Mon, 10 Sep 2007 23:19:34 +0000
changeset 19926
fd8c090b8516
parent 16961
b6955f946f8f
child 33100
9c6db78cce0b
permissions
-rw-r--r--

Protocol's (and other plugin's) PurplePluginInfo structs should really be
static. If this breaks the myspace prpl let me know (I don't use it) because
that will need fixing in some other way.

15998
294277e634fc More gaim->whatever isms
Mark Doliner <markdoliner@pidgin.im>
parents: 15371
diff changeset
1 Purple, Pidgin and Finch
0
7b1da07f853f [gaim-migrate @ 9]
Rob Flynn <gaim@robflynn.com>
parents:
diff changeset
2 ========================
15998
294277e634fc More gaim->whatever isms
Mark Doliner <markdoliner@pidgin.im>
parents: 15371
diff changeset
3 See AUTHORS and COPYRIGHT for the list of contributors.
294277e634fc More gaim->whatever isms
Mark Doliner <markdoliner@pidgin.im>
parents: 15371
diff changeset
4
294277e634fc More gaim->whatever isms
Mark Doliner <markdoliner@pidgin.im>
parents: 15371
diff changeset
5 libpurple is a library intended to be used by programmers seeking
294277e634fc More gaim->whatever isms
Mark Doliner <markdoliner@pidgin.im>
parents: 15371
diff changeset
6 to write an IM client that connects to many IM networks. It supports
16961
b6955f946f8f s/Jabber/XMPP in user-visible places.
Richard Laager <rlaager@pidgin.im>
parents: 16799
diff changeset
7 AIM, ICQ, XMPP, MSN and Yahoo!, among others.
0
7b1da07f853f [gaim-migrate @ 9]
Rob Flynn <gaim@robflynn.com>
parents:
diff changeset
8
15998
294277e634fc More gaim->whatever isms
Mark Doliner <markdoliner@pidgin.im>
parents: 15371
diff changeset
9 Pidgin is an graphical IM client written in C which uses the GTK+
294277e634fc More gaim->whatever isms
Mark Doliner <markdoliner@pidgin.im>
parents: 15371
diff changeset
10 toolkit.
2608
af4b9ddb6365 [gaim-migrate @ 2621]
Eric Warmenhoven <warmenhoven@yahoo.com>
parents: 2536
diff changeset
11
16002
Richard Nelson <wabz@pidgin.im>
parents: 15998
diff changeset
12 Finch is a text-based IM client written in C which uses the ncurses
15998
294277e634fc More gaim->whatever isms
Mark Doliner <markdoliner@pidgin.im>
parents: 15371
diff changeset
13 toolkit.
294277e634fc More gaim->whatever isms
Mark Doliner <markdoliner@pidgin.im>
parents: 15371
diff changeset
14
294277e634fc More gaim->whatever isms
Mark Doliner <markdoliner@pidgin.im>
parents: 15371
diff changeset
15 These programs are not endorsed by, nor affiliated with, AOL nor any
294277e634fc More gaim->whatever isms
Mark Doliner <markdoliner@pidgin.im>
parents: 15371
diff changeset
16 other company in any way.
2862
962a6d4da169 [gaim-migrate @ 2875]
Eric Warmenhoven <warmenhoven@yahoo.com>
parents: 2777
diff changeset
17
962a6d4da169 [gaim-migrate @ 2875]
Eric Warmenhoven <warmenhoven@yahoo.com>
parents: 2777
diff changeset
18 BUILD
962a6d4da169 [gaim-migrate @ 2875]
Eric Warmenhoven <warmenhoven@yahoo.com>
parents: 2777
diff changeset
19 =====
0
7b1da07f853f [gaim-migrate @ 9]
Rob Flynn <gaim@robflynn.com>
parents:
diff changeset
20
2862
962a6d4da169 [gaim-migrate @ 2875]
Eric Warmenhoven <warmenhoven@yahoo.com>
parents: 2777
diff changeset
21 Read the 'INSTALL' file for more detailed directions.
0
7b1da07f853f [gaim-migrate @ 9]
Rob Flynn <gaim@robflynn.com>
parents:
diff changeset
22
15998
294277e634fc More gaim->whatever isms
Mark Doliner <markdoliner@pidgin.im>
parents: 15371
diff changeset
23 These programs use the standard ./configure ; make. You need to use
294277e634fc More gaim->whatever isms
Mark Doliner <markdoliner@pidgin.im>
parents: 15371
diff changeset
24 gmake, BSD make probably won't work. Remember, run ./configure --help
294277e634fc More gaim->whatever isms
Mark Doliner <markdoliner@pidgin.im>
parents: 15371
diff changeset
25 to see what build options are available.
2862
962a6d4da169 [gaim-migrate @ 2875]
Eric Warmenhoven <warmenhoven@yahoo.com>
parents: 2777
diff changeset
26
15998
294277e634fc More gaim->whatever isms
Mark Doliner <markdoliner@pidgin.im>
parents: 15371
diff changeset
27 In order to compile Pidgin you need to have GTK+ 2.0 installed (as
2862
962a6d4da169 [gaim-migrate @ 2875]
Eric Warmenhoven <warmenhoven@yahoo.com>
parents: 2777
diff changeset
28 well as the development files!). The configure script will fail if you
16002
Richard Nelson <wabz@pidgin.im>
parents: 15998
diff changeset
29 don't. If you don't have GTK+ 2.0 installed, you should install it
Richard Nelson <wabz@pidgin.im>
parents: 15998
diff changeset
30 using your distribution's package management tools.
0
7b1da07f853f [gaim-migrate @ 9]
Rob Flynn <gaim@robflynn.com>
parents:
diff changeset
31
15371
a26902f93720 [gaim-migrate @ 18100]
Luke Schierer <lschiere@pidgin.im>
parents: 13633
diff changeset
32 For sound support, you also need gstreamer 0.10 or higher. For
a26902f93720 [gaim-migrate @ 18100]
Luke Schierer <lschiere@pidgin.im>
parents: 13633
diff changeset
33 spellchecking support, you need libgtkspell (http://gtkspell.sf.net/).
a26902f93720 [gaim-migrate @ 18100]
Luke Schierer <lschiere@pidgin.im>
parents: 13633
diff changeset
34 Your distro of choice probably already includes these, just be sure to
a26902f93720 [gaim-migrate @ 18100]
Luke Schierer <lschiere@pidgin.im>
parents: 13633
diff changeset
35 install the development packages.
2862
962a6d4da169 [gaim-migrate @ 2875]
Eric Warmenhoven <warmenhoven@yahoo.com>
parents: 2777
diff changeset
36
962a6d4da169 [gaim-migrate @ 2875]
Eric Warmenhoven <warmenhoven@yahoo.com>
parents: 2777
diff changeset
37 RUN
962a6d4da169 [gaim-migrate @ 2875]
Eric Warmenhoven <warmenhoven@yahoo.com>
parents: 2777
diff changeset
38 ===
0
7b1da07f853f [gaim-migrate @ 9]
Rob Flynn <gaim@robflynn.com>
parents:
diff changeset
39
2862
962a6d4da169 [gaim-migrate @ 2875]
Eric Warmenhoven <warmenhoven@yahoo.com>
parents: 2777
diff changeset
40 You should run 'make install' as root to make sure plugins and other files
962a6d4da169 [gaim-migrate @ 2875]
Eric Warmenhoven <warmenhoven@yahoo.com>
parents: 2777
diff changeset
41 get installed into locations they want to be in. Once you've done that,
15998
294277e634fc More gaim->whatever isms
Mark Doliner <markdoliner@pidgin.im>
parents: 15371
diff changeset
42 you only need to run 'pidgin' or 'finch'.
0
7b1da07f853f [gaim-migrate @ 9]
Rob Flynn <gaim@robflynn.com>
parents:
diff changeset
43
16237
606a402fea87 Beat some older documentation into submission.
Richard Laager <rlaager@pidgin.im>
parents: 16002
diff changeset
44 To get started, simply add a new account.
1400
a12d24a021f6 [gaim-migrate @ 1410]
Eric Warmenhoven <warmenhoven@yahoo.com>
parents: 1161
diff changeset
45
16237
606a402fea87 Beat some older documentation into submission.
Richard Laager <rlaager@pidgin.im>
parents: 16002
diff changeset
46 If you come across a bug, please report it at: http://pidgin.im
0
7b1da07f853f [gaim-migrate @ 9]
Rob Flynn <gaim@robflynn.com>
parents:
diff changeset
47
2862
962a6d4da169 [gaim-migrate @ 2875]
Eric Warmenhoven <warmenhoven@yahoo.com>
parents: 2777
diff changeset
48 PLUGINS
962a6d4da169 [gaim-migrate @ 2875]
Eric Warmenhoven <warmenhoven@yahoo.com>
parents: 2777
diff changeset
49 =======
2318
2e5108f70338 [gaim-migrate @ 2328]
Eric Warmenhoven <warmenhoven@yahoo.com>
parents: 2142
diff changeset
50
15998
294277e634fc More gaim->whatever isms
Mark Doliner <markdoliner@pidgin.im>
parents: 15371
diff changeset
51 If you do not wish to enable the plugin support within Purple, run the
2318
2e5108f70338 [gaim-migrate @ 2328]
Eric Warmenhoven <warmenhoven@yahoo.com>
parents: 2142
diff changeset
52 ./configure script with the --disable-plugins option and recompile your
2e5108f70338 [gaim-migrate @ 2328]
Eric Warmenhoven <warmenhoven@yahoo.com>
parents: 2142
diff changeset
53 source code. This will prevent the ability to load plugins.
2e5108f70338 [gaim-migrate @ 2328]
Eric Warmenhoven <warmenhoven@yahoo.com>
parents: 2142
diff changeset
54
15998
294277e634fc More gaim->whatever isms
Mark Doliner <markdoliner@pidgin.im>
parents: 15371
diff changeset
55 'make install' puts the plugins in $PREFIX/lib/purple (PREFIX being what
294277e634fc More gaim->whatever isms
Mark Doliner <markdoliner@pidgin.im>
parents: 15371
diff changeset
56 you specified when you ./configure'd - it defaults to /usr/local). Purple
16237
606a402fea87 Beat some older documentation into submission.
Richard Laager <rlaager@pidgin.im>
parents: 16002
diff changeset
57 looks for the plugins in that directory by default. Plugins can be installed
606a402fea87 Beat some older documentation into submission.
Richard Laager <rlaager@pidgin.im>
parents: 16002
diff changeset
58 per-user in ~/.purple/plugins as well. Pidgin and Finch also look in
606a402fea87 Beat some older documentation into submission.
Richard Laager <rlaager@pidgin.im>
parents: 16002
diff changeset
59 $PREFIX/lib/pidgin and $PREFIX/lib/finch for UI-specific, respectively.
2862
962a6d4da169 [gaim-migrate @ 2875]
Eric Warmenhoven <warmenhoven@yahoo.com>
parents: 2777
diff changeset
60
962a6d4da169 [gaim-migrate @ 2875]
Eric Warmenhoven <warmenhoven@yahoo.com>
parents: 2777
diff changeset
61 To build a plugin from a .c file, put it in the plugins/ directory in
962a6d4da169 [gaim-migrate @ 2875]
Eric Warmenhoven <warmenhoven@yahoo.com>
parents: 2777
diff changeset
62 the source and run 'make filename.so', e.g. if you have the .c file
962a6d4da169 [gaim-migrate @ 2875]
Eric Warmenhoven <warmenhoven@yahoo.com>
parents: 2777
diff changeset
63 'kickass.c', put it in the plugins/ directory, and from that directory,
962a6d4da169 [gaim-migrate @ 2875]
Eric Warmenhoven <warmenhoven@yahoo.com>
parents: 2777
diff changeset
64 run 'make kickass.so'.
962a6d4da169 [gaim-migrate @ 2875]
Eric Warmenhoven <warmenhoven@yahoo.com>
parents: 2777
diff changeset
65

mercurial