Mercurial > pidgin

comparison README @ 20394:4a099e4d0d09

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
propagate from branch 'im.pidgin.pidgin' (head 98b6b547b29ea1192b73cc4e1de1e674edef4328) to branch 'im.pidgin.rlaager.merging.msnp13-and-pidgin' (head 4d82c29e56bd33cd6f94302e343dfeb5d68ab3eb)
author Richard Laager <rlaager@wiktel.com>
date Sun, 15 Apr 2007 03:43:17 +0000
parents 47a9454dbb95
children 83ec0b408926
comparison
equal deleted inserted replaced
20393:40a04930b233 20394:4a099e4d0d09
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 gstreamer 0.10 or higher. For 32 For sound support, you also need gstreamer 0.10 or higher. For
28 spellchecking support, you need libgtkspell (http://gtkspell.sf.net/). 33 spellchecking support, you need libgtkspell (http://gtkspell.sf.net/).
29 Your distro of choice probably already includes these, just be sure to 34 Your distro of choice probably already includes these, just be sure to
30 install the development packages. 35 install the development packages.
32 RUN 37 RUN
33 === 38 ===
34 39
35 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
36 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,
37 you only need to run 'gaim'. 42 you only need to run 'pidgin' or 'finch'.
38 43
39 Protocol plugins (prpls) are now automatically loaded. Simply go to the 44 Protocol plugins (PRPLs) are now automatically loaded. Simply go to the
40 account editor, add a new account, and all supported protocols will be 45 account editor, add a new account, and all supported protocols will be
41 there. Be sure to use OSCAR (AIM/ICQ) and not the old TOC or ICQ plugins. 46 there. Be sure to use OSCAR (AIM/ICQ) and not the old TOC or ICQ plugins.
42 47
43 Read below for protocol-specific information. 48 Read below for protocol-specific information.
44 49
45 50
46 PLUGINS 51 PLUGINS
47 ======= 52 =======
48 53
49 If you do not wish to enable the plugin support within Gaim, run the 54 If you do not wish to enable the plugin support within Purple, run the
50 ./configure script with the --disable-plugins option and recompile your 55 ./configure script with the --disable-plugins option and recompile your
51 source code. This will prevent the ability to load plugins. 56 source code. This will prevent the ability to load plugins.
52 57
53 'make install' puts the plugins in $PREFIX/lib/gaim (PREFIX being what 58 'make install' puts the plugins in $PREFIX/lib/purple (PREFIX being what
54 you specified when you ./configure'd - it defaults to /usr/local). Gaim 59 you specified when you ./configure'd - it defaults to /usr/local). Purple
55 looks for the plugins in that directory by default, but they do not have 60 looks for the plugins in that directory by default, but they do not have
56 to be there to use them. Also, plugins have a .so extension by default, 61 to be there to use them. Also, plugins have a .so extension by default,
57 though they do not have to. 62 though they do not have to.
58 63
59 To build a plugin from a .c file, put it in the plugins/ directory in 64 To build a plugin from a .c file, put it in the plugins/ directory in
67 72
68 If you manually set a command for your browser or sound player options, 73 If you manually set a command for your browser or sound player options,
69 make sure to put double-quotes around the "%s", otherwise bad things may 74 make sure to put double-quotes around the "%s", otherwise bad things may
70 happen. 75 happen.
71 76
72 If you come across a bug, please report it to http://gaim.sf.net/bug.php. 77 If you come across a bug, please report it to http://pidgin.im/.
73
74 See README.SVN for information on the bleeding edge SVN version of Gaim.
75 You probably shouldn't use it, as it may eat your children, as well as
76 your settings.
77 78
78 79
79 PROTOCOL INFORMATION 80 PROTOCOL INFORMATION
80 ==================== 81 ====================
81 82
99 Oscar (Mark) 100 Oscar (Mark)
100 ===== 101 =====
101 102
102 Oscar is the default protocol. It is recommended that you use Oscar for 103 Oscar is the default protocol. It is recommended that you use Oscar for
103 both AIM and ICQ, as TOC isn't very featureful and the old ICQ protocol no 104 both AIM and ICQ, as TOC isn't very featureful and the old ICQ protocol no
104 longer works. 105 longer works.
105 106
106 For AIM, Oscar can get people's away messages. It can request and accept 107 For AIM, Oscar can get people's away messages. It can request and accept
107 Direct Connections, and has limited support for file transfer. IM Image 108 Direct Connections, and has limited support for file transfer. IM Image
108 does not currently work. It can send and receive buddy icons if you have 109 does not currently work. It can send and receive buddy icons if you have
109 GdkPixbuf. 110 GdkPixbuf.
110 111
111 For ICQ, it supports nearly everything that the old ICQ plugin supported, 112 For ICQ, it supports nearly everything that the old ICQ plugin supported,
112 which isn't much. To use Oscar for ICQ, enter your ICQ UIN as the 113 which isn't much. To use Oscar for ICQ, enter your ICQ UIN as the
113 screenname. The default host/port will work. You'll need to use a different 114 screenname. The default host/port will work. You'll need to use a different
118 ===== 119 =====
119 120
120 Yahoo is currently using the new YMSG protocol that newer official Yahoo 121 Yahoo is currently using the new YMSG protocol that newer official Yahoo
121 clients are using. This protocol is much better than the old one, and 122 clients are using. This protocol is much better than the old one, and
122 tends to be somewhat more reliable. However, the Yahoo service is still 123 tends to be somewhat more reliable. However, the Yahoo service is still
123 flaky at best. 124 flaky at best.
124 125
125 126
126 IRC (Ethan) 127 IRC (Ethan)
127 === 128 ===
128 129
132 in an IM window where the "Send Message As" menu is set to your IRC 133 in an IM window where the "Send Message As" menu is set to your IRC
133 account. There are other / commands that work in IM and Chat windows for 134 account. There are other / commands that work in IM and Chat windows for
134 IRC, /help will give you a list of them. 135 IRC, /help will give you a list of them.
135 136
136 137
137 MSN (Christian) 138 MSN
138 === 139 ===
139 140
140 With MSN you can join a conversation with several people, but you can't 141 With MSN you can join a conversation with several people, but you can't
141 invite people from the IM window yet. 142 invite people from the IM window yet.
142 143
143 144
144 ICQ (Mark)
145 ===
146
147 The ICQ plugin is deprecated and will probably be removed soon. The
148 protocol only marginally works. You should use Oscar for ICQ. You'll
149 need a different client to register an ICQ account if you don't have
150 one yet.
151
152
153 Jabber (Nathan) 145 Jabber (Nathan)
154 ====== 146 ======
155 147
156 Transports aren't currently supported at all, though if you have a 148 Transports aren't currently supported at all, though if you have a
157 transport already subscribed Gaim will use it (you can't add or remove 149 transport already subscribed Purple will use it (you can't add or remove
158 transports though). In order to use a server other than jabber.org, set 150 transports though). In order to use a server other than jabber.org, set
159 your username to include the server, e.g. warmenhoven@mycompany.com. This 151 your username to include the server, e.g. warmenhoven@mycompany.com. This
160 is the actual format of the Jabber ID anyway; Jabber is email with online 152 is the actual format of the Jabber ID anyway; Jabber is email with online
161 notification. You can register a new Jabber account by checking the 153 notification. You can register a new Jabber account by checking the
162 appropriate box in the account editor for your Jabber account. 154 appropriate box in the account editor for your Jabber account.
163
164
165 Napster (Mark)
166 =======
167
168 Heh. Ok, so I (Rob) am on crack! Gaim can sign on/off of Napster,
169 add/remove people to your hotlist (buddylist) as well as chat privately
170 and in chat rooms. You can search for files and browse a list of other
171 user's files. You can currently download files as long as the person
172 you're retrieving files from is not firewalled.
173 155
174 156
175 Zephyr (Sean) 157 Zephyr (Sean)
176 ====== 158 ======
177 159
178 Let me start off by saying how much I really despise Zephyr. They do a 160 Let me start off by saying how much I really despise Zephyr. They do a
179 lot of things that make me realize why this never caught on. For those 161 lot of things that make me realize why this never caught on. For those
180 of you who are unfortunate enough to feel compelling need to use this, 162 of you who are unfortunate enough to feel compelling need to use this,
181 gaim now has a Zephyr plugin. It can currently sign on/off, handles 163 Purple now has a Zephyr plugin. It can currently sign on/off, handles
182 presence/buddy lists (it even imports your .anyone file!), and can 164 presence/buddy lists (it even imports your .anyone file!), and can
183 send/receive personal messages. A lot of stuff is missing, this is just 165 send/receive personal messages. A lot of stuff is missing, this is just
184 a real rough first stab at it. 166 a real rough first stab at it.
185 167
186 168