Mercurial > pidgin.yaz
comparison README @ 16177:d88f0f320c9b
merge of '07fc4db9a3c2c12596e0354b8e7959aa847f966b'
and '2e6d324c725b3e6a2c803589bca3f0ac9b9790bf'
author | Richard Laager <rlaager@wiktel.com> |
---|---|
date | Mon, 16 Apr 2007 00:44:33 +0000 |
parents | 83ec0b408926 |
children | 3bd360f26a9e |
comparison
equal
deleted
inserted
replaced
14940:2e3eba412412 | 16177:d88f0f320c9b |
---|---|
1 gaim | 1 Purple, Pidgin and Finch |
2 ======================== | 2 ======================== |
3 Rob Flynn <gaim@robflynn.com> IM: RobFlynn (current maintainer) | 3 See AUTHORS and COPYRIGHT for the list of contributors. |
4 Syd Logan - Super Hacker and Resident Designated Driver | |
5 Jim Duchek <jimduchek@ou.edu> IM: Zilding (former maintainer) | |
6 Eric Warmenhoven <eric@warmenhoven.org> (retired) | |
7 Mark Spencer <markster@marko.net> | |
8 | 4 |
9 Gaim is an IM client that supports many protocols, including AIM, ICQ, | 5 libpurple is a library intended to be used by programmers seeking |
10 MSN, IRC, and Jabber. Gaim is NOT endorsed by, nor affiliated with, | 6 to write an IM client that connects to many IM networks. It supports |
11 AOL nor any other company in ANY way. | 7 AIM, ICQ, Jabber, MSN and Yahoo!, among others. |
12 | 8 |
9 Pidgin is an graphical IM client written in C which uses the GTK+ | |
10 toolkit. | |
11 | |
12 Finch is a text-based IM client written in C which uses the ncurses | |
13 toolkit. | |
14 | |
15 These programs are not endorsed by, nor affiliated with, AOL nor any | |
16 other company in any way. | |
13 | 17 |
14 BUILD | 18 BUILD |
15 ===== | 19 ===== |
16 | 20 |
17 Read the 'INSTALL' file for more detailed directions. | 21 Read the 'INSTALL' file for more detailed directions. |
18 | 22 |
19 Gaim uses the standard ./configure ; make. You need to use gmake, BSD | 23 These programs use the standard ./configure ; make. You need to use |
20 make probably won't work. Remember, run ./configure --help to see what | 24 gmake, BSD make probably won't work. Remember, run ./configure --help |
21 build options are available. | 25 to see what build options are available. |
22 | 26 |
23 In order to compile Gaim, you need to have GTK+ 2.0 installed (as | 27 In order to compile Pidgin you need to have GTK+ 2.0 installed (as |
24 well as the development files!). The configure script will fail if you | 28 well as the development files!). The configure script will fail if you |
25 don't. You can get it from http://www.gtk.org/. | 29 don't. If you don't have GTK+ 2.0 installed, you should install it |
30 using your distribution's package management tools. | |
26 | 31 |
27 For sound support, you also need libao | 32 For sound support, you also need gstreamer 0.10 or higher. For |
28 (http://freshmeat.net/projects/libao/) and libaudiofile | 33 spellchecking support, you need libgtkspell (http://gtkspell.sf.net/). |
29 (http://www.68k.org/~michael/audiofile/). For spellchecking support, you | 34 Your distro of choice probably already includes these, just be sure to |
30 need libgtkspell (http://gtkspell.sf.net/). Your distro of choice | 35 install the development packages. |
31 probably already includes these, just be sure to install the development | |
32 packages. | |
33 | 36 |
34 RUN | 37 RUN |
35 === | 38 === |
36 | 39 |
37 You should run 'make install' as root to make sure plugins and other files | 40 You should run 'make install' as root to make sure plugins and other files |
38 get installed into locations they want to be in. Once you've done that, | 41 get installed into locations they want to be in. Once you've done that, |
39 you only need to run 'gaim'. | 42 you only need to run 'pidgin' or 'finch'. |
40 | 43 |
41 Protocol plugins (prpls) are now automatically loaded. Simply go to the | 44 To get started, simply add a new account. |
42 account editor, add a new account, and all supported protocols will be | |
43 there. Be sure to use OSCAR (AIM/ICQ) and not the old TOC or ICQ plugins. | |
44 | 45 |
45 Read below for protocol-specific information. | 46 If you come across a bug, please report it at: http://pidgin.im |
46 | |
47 | 47 |
48 PLUGINS | 48 PLUGINS |
49 ======= | 49 ======= |
50 | 50 |
51 If you do not wish to enable the plugin support within Gaim, run the | 51 If you do not wish to enable the plugin support within Purple, run the |
52 ./configure script with the --disable-plugins option and recompile your | 52 ./configure script with the --disable-plugins option and recompile your |
53 source code. This will prevent the ability to load plugins. | 53 source code. This will prevent the ability to load plugins. |
54 | 54 |
55 'make install' puts the plugins in $PREFIX/lib/gaim (PREFIX being what | 55 'make install' puts the plugins in $PREFIX/lib/purple (PREFIX being what |
56 you specified when you ./configure'd - it defaults to /usr/local). Gaim | 56 you specified when you ./configure'd - it defaults to /usr/local). Purple |
57 looks for the plugins in that directory by default, but they do not have | 57 looks for the plugins in that directory by default. Plugins can be installed |
58 to be there to use them. Also, plugins have a .so extension by default, | 58 per-user in ~/.purple/plugins as well. Pidgin and Finch also look in |
59 though they do not have to. | 59 $PREFIX/lib/pidgin and $PREFIX/lib/finch for UI-specific, respectively. |
60 | 60 |
61 To build a plugin from a .c file, put it in the plugins/ directory in | 61 To build a plugin from a .c file, put it in the plugins/ directory in |
62 the source and run 'make filename.so', e.g. if you have the .c file | 62 the source and run 'make filename.so', e.g. if you have the .c file |
63 'kickass.c', put it in the plugins/ directory, and from that directory, | 63 'kickass.c', put it in the plugins/ directory, and from that directory, |
64 run 'make kickass.so'. | 64 run 'make kickass.so'. |
65 | 65 |
66 | |
67 NOTES | |
68 ===== | |
69 | |
70 If you manually set a command for your browser or sound player options, | |
71 make sure to put double-quotes around the "%s", otherwise bad things may | |
72 happen. | |
73 | |
74 If you come across a bug, please report it to http://gaim.sf.net/bug.php. | |
75 | |
76 See README.CVS for information on the bleeding edge CVS version of Gaim. | |
77 You probably shouldn't use it, as it may eat your children, as well as | |
78 your settings. | |
79 | |
80 | |
81 PROTOCOL INFORMATION | |
82 ==================== | |
83 | |
84 Each protocol is hacked by both Rob and Eric, though there is one person | |
85 that kind of "owns" a protocol (mostly indicating that they were the | |
86 person that originally wrote it). Their name will be next to the protocol; | |
87 they're the people to complain to when something doesn't work ;). | |
88 | |
89 | |
90 TOC (Mark) | |
91 === | |
92 | |
93 You shouldn't use TOC, you should use Oscar instead. TOC can sync your | |
94 buddy list with the server (if it's not too long), and can respond to file | |
95 transfer requests (both sending and receiving). Other than that, there's | |
96 nothing it can do that Oscar can't, yet. The TOC protocol doesn't allow | |
97 retrieval of away messages; isn't capable of sending or receiving buddy | |
98 icons; it also can't make file transfer requests. | |
99 | |
100 | |
101 Oscar (Mark) | |
102 ===== | |
103 | |
104 Oscar is the default protocol. It is recommended that you use Oscar for | |
105 both AIM and ICQ, as TOC isn't very featureful and the old ICQ protocol no | |
106 longer works. | |
107 | |
108 For AIM, Oscar can get people's away messages. It can request and accept | |
109 Direct Connections, and has limited support for file transfer. IM Image | |
110 does not currently work. It can send and receive buddy icons if you have | |
111 GdkPixbuf. | |
112 | |
113 For ICQ, it supports nearly everything that the old ICQ plugin supported, | |
114 which isn't much. To use Oscar for ICQ, enter your ICQ UIN as the | |
115 screenname. The default host/port will work. You'll need to use a different | |
116 client to register a new ICQ account if you don't have one yet. | |
117 | |
118 | |
119 Yahoo (Sean) | |
120 ===== | |
121 | |
122 Yahoo is currently using the new YMSG protocol that newer official Yahoo | |
123 clients are using. This protocol is much better than the old one, and | |
124 tends to be somewhat more reliable. However, the Yahoo service is still | |
125 flaky at best. | |
126 | |
127 | |
128 IRC (Ethan) | |
129 === | |
130 | |
131 There are three ways to join an IRC chat room. The first is the File->Join | |
132 A Chat menu option in the Buddy List window. The second is the "Chat" | |
133 button at the bottom of the buddy list. The third is to type "/join #name" | |
134 in an IM window where the "Send Message As" menu is set to your IRC | |
135 account. There are other / commands that work in IM and Chat windows for | |
136 IRC, /help will give you a list of them. | |
137 | |
138 | |
139 MSN (Christian) | |
140 === | |
141 | |
142 With MSN you can join a conversation with several people, but you can't | |
143 invite people from the IM window yet. | |
144 | |
145 | |
146 ICQ (Mark) | |
147 === | |
148 | |
149 The ICQ plugin is deprecated and will probably be removed soon. The | |
150 protocol only marginally works. You should use Oscar for ICQ. You'll | |
151 need a different client to register an ICQ account if you don't have | |
152 one yet. | |
153 | |
154 | |
155 Jabber (Nathan) | |
156 ====== | |
157 | |
158 Transports aren't currently supported at all, though if you have a | |
159 transport already subscribed Gaim will use it (you can't add or remove | |
160 transports though). In order to use a server other than jabber.org, set | |
161 your username to include the server, e.g. warmenhoven@mycompany.com. This | |
162 is the actual format of the Jabber ID anyway; Jabber is email with online | |
163 notification. You can register a new Jabber account by checking the | |
164 appropriate box in the account editor for your Jabber account. | |
165 | |
166 | |
167 Napster (Mark) | |
168 ======= | |
169 | |
170 Heh. Ok, so I (Rob) am on crack! Gaim can sign on/off of Napster, | |
171 add/remove people to your hotlist (buddylist) as well as chat privately | |
172 and in chat rooms. You can search for files and browse a list of other | |
173 user's files. You can currently download files as long as the person | |
174 you're retrieving files from is not firewalled. | |
175 | |
176 | |
177 Zephyr (Sean) | |
178 ====== | |
179 | |
180 Let me start off by saying how much I really despise Zephyr. They do a | |
181 lot of things that make me realize why this never caught on. For those | |
182 of you who are unfortunate enough to feel compelling need to use this, | |
183 gaim now has a Zephyr plugin. It can currently sign on/off, handles | |
184 presence/buddy lists (it even imports your .anyone file!), and can | |
185 send/receive personal messages. A lot of stuff is missing, this is just | |
186 a real rough first stab at it. | |
187 | |
188 | |
189 Gadu-Gadu (Sean) | |
190 ========= | |
191 | |
192 I really shouldn't be taking credit for Gadu-Gadu, I'm just the person who | |
193 commits the patches that Arkadiusz Miskiewicz gives me. Gadu-Gadu is an IM | |
194 system most similar to ICQ that is quite popular in Poland. It can manage | |
195 your server-side buddy list through the Protocol Actions menu. You'll need | |
196 to use a different client to register a new account if you don't have one | |
197 yet. |