README

   1 gaim
   2 ========================
   3 Rob Flynn <rob@marko.net> IM: RobFlynn (currnet maintainer)
   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
   9 Gaim is an IM client that supports many protocols, including AIM, ICQ,
  10 MSN, IRC, and Jabber. Gaim is NOT endorsed by, nor affiliated with,
  11 AOL nor any other company in ANY way.
  12
  13
  14 BUILD
  15 =====
  16
  17 Read the 'INSTALL' file for more detailed directions.
  18
  19 Gaim uses the standard ./configure ; make. You need to use gmake, BSD
  20 make probably won't work. Remember, run ./configure --help to see what
  21 build options are available.
  22
  23 In order to compile Gaim, you need to have GTK+ 1.2.5 installed (as
  24 well as the development files!). The configure script will fail if you
  25 don't. You can get it from http://www.gtk.org/.
  26
  27 Gaim will try to compile with Gnome features if you have Gnome on your
  28 system. If you don't have them, it will settle for simply GTK. If you
  29 don't want Gnome bits, ./configure --disable-gnome
  30
  31 If you want to build as a GNOME applet:
  32 ./configure --enable-panel ; make
  33 then su to root and run "make install".
  34 Afterwards panel->Add applet->Network->Gaim should be there.
  35
  36
  37 RUN
  38 ===
  39
  40 You should run 'make install' as root to make sure plugins and other files
  41 get installed into locations they want to be in. Once you've done that,
  42 you only need to run 'gaim'.
  43
  44 To use the other services (such as Yahoo and IRC) which are available
  45 as plugins:
  46
  47 They are installed in $libdir/gaim, which usually is either /usr/lib/gaim
  48 or /usr/local/lib/gaim, and should have a somewhat descriptive name (e.g.
  49 libyahoo.so or libirc.so). Load those plugins using the normal plugin
  50 dialog.  Then in the account editor, add a new account; the Protocol option
  51 menu should now have another option for the protocol that you loaded. Then
  52 you can sign that account on.
  53
  54 Read below for protocol-specific information.
  55
  56
  57 PLUGINS
  58 =======
  59
  60 If you do not wish to enable the plugin support within Gaim, run the
  61 ./configure script with the --disable-plugins option and recompile your
  62 source code.  This will prevent the ability to load plugins.
  63
  64 'make install' puts the plugins in $PREFIX/lib/gaim (PREFIX being what
  65 you specified when you ./configure'd - it defaults to /usr/local). Gaim
  66 looks for the plugins in that directory by default, but they do not have
  67 to be there to use them. Also, plugins have a .so extension by default,
  68 though they do not have to.
  69
  70 To build a plugin from a .c file, put it in the plugins/ directory in
  71 the source and run 'make filename.so', e.g. if you have the .c file
  72 'kickass.c', put it in the plugins/ directory, and from that directory,
  73 run 'make kickass.so'.
  74
  75
  76 NOTES
  77 =====
  78
  79 If you manually set a command for your browser or sound player options,
  80 make sure to put double-quotes around the "%s", otherwise bad things may
  81 happen.
  82
  83 If you come across a bug, please report it to http://gaim.sf.net/bug.php.
  84
  85 There always seems to be some iffy-ness by a lot of people about
  86 whether to use the CVS version or stick with a stable release. Use the
  87 CVS version. If you need a version that you know is reliable, then keep
  88 your favorite one in case of an emergency. But for the most part, gaim
  89 is not mission-critical software, and if you can help us find a few bugs
  90 before we release, all the better. (Also, CVS tends to be more stable
  91 than releases, since we get 10 or 12 bug reports right after we make a
  92 release, and all those bugs are fixed within a day or two usually.) Read
  93 http://gaim.sf.net/cvs.php for more information.
  94
  95
  96 PROTOCOL INFORMATION
  97 ====================
  98
  99 Each protocol is hacked by both Rob and Eric, though there is one person
 100 that kind of "owns" a protocol (mostly indicating that they were the
 101 person that originally wrote it). Their name will be next to the protocol;
 102 they're the people to complain to when something doesn't work ;).
 103
 104
 105 TOC (Rob)
 106 ===
 107
 108 You shouldn't use TOC, you should use Oscar instead. TOC can sync your
 109 buddy list with the server (if it's not too long), and can respond to file
 110 transfer requests (both sending and receiving). Other than that, there's
 111 nothing it can do that Oscar can't, yet. The TOC protocol doesn't allow
 112 retrieval of away messages; isn't capable of sending or receiving buddy
 113 icons; it also can't make file transfer requests.
 114
 115
 116 Oscar (Eric)
 117 =====
 118
 119 Oscar is the default protocol. It is recommended that you use Oscar for
 120 both AIM and ICQ, as TOC isn't very featureful and the old ICQ protocol no
 121 longer works.
 122
 123 For AIM, Oscar can get people's away messages. It can request and accept
 124 Direct IM connections, but it cannot yet transfer files through this (or
 125 through any other means). It can send and receive buddy icons if you have
 126 GdkPixbuf.
 127
 128 For ICQ, it supports nearly everything that the old ICQ plugin supported,
 129 which isn't much. To use Oscar for ICQ, enter your ICQ UIN as the
 130 screenname. The default host/port will work. You'll need to use a different
 131 client to register a new ICQ account if you don't have one yet.
 132
 133
 134 Yahoo (Eric)
 135 =====
 136
 137 Yahoo is currently using the new YMSG protocol that newer official Yahoo
 138 clients are using. This protocol is much better than the old one, and
 139 tends to be somewhat more reliable. However, the Yahoo service is still
 140 flaky at best. Group chats aren't supported yet.
 141
 142
 143 IRC (Eric)
 144 ===
 145
 146 There are three ways to join an IRC chat room. The first is the File->Join
 147 A Chat menu option in the Buddy List window. The second is the "Chat"
 148 button at the bottom of the buddy list. The third is to type "/join #name"
 149 in an IM window where the "Send Message As" menu is set to your IRC
 150 account. There are other / commands that work in IM and Chat windows for
 151 IRC, /help will give you a list of them.
 152
 153
 154 MSN (Eric)
 155 ===
 156
 157 With MSN you can join a conversation with several people, but you can't
 158 invite people from the IM window yet.
 159
 160
 161 ICQ (Eric)
 162 ===
 163
 164 The ICQ plugin is deprecated and will probably be removed soon. The
 165 protocol only marginally works. You should use Oscar for ICQ. You'll
 166 need a different client to register an ICQ account if you don't have
 167 one yet.
 168
 169
 170 Jabber (Eric)
 171 ======
 172
 173 Transports aren't currently supported at all, though if you have a
 174 transport already subscribed Gaim will use it (you can't add or remove
 175 transports though). In order to use a server other than jabber.org, set
 176 your username to include the server, e.g. warmenhoven@mycompany.com. This
 177 is the actual format of the Jabber ID anyway; Jabber is email with online
 178 notification. You'll need to use a different client to register a Jabber
 179 account if you don't have one yet.
 180
 181
 182 Napster (Rob)
 183 =======
 184
 185 Heh.  Ok, so I (Rob) am on crack!  Gaim can sign on/off of Napster,
 186 add/remove people to your hotlist (buddylist) as well as chat privately
 187 and in chat rooms.  You can search for files and browse a list of other
 188 user's files.  You can currently download files as long as the person
 189 you're retrieving files from is not firewalled.
 190
 191
 192 Zephyr (Eric)
 193 ======
 194
 195 Let me start off by saying how much I really despise Zephyr. They do a
 196 lot of things that make me realize why this never caught on. For those
 197 of you who are unfortunate enough to feel compelling need to use this,
 198 gaim now has a Zephyr plugin. It can currently sign on/off, handles
 199 presence/buddy lists (it even imports your .anyone file!), and can
 200 send/receive personal messages. A lot of stuff is missing, this is just
 201 a real rough first stab at it.
 202
 203
 204 Gadu-Gadu (Eric)
 205 =========
 206
 207 I really shouldn't be taking credit for Gadu-Gadu, I'm just the person who
 208 commits the patches that Arkadiusz Miskiewicz gives me. Gadu-Gadu is an IM
 209 system most similar to ICQ that is quite popular in Poland. It can manage
 210 your server-side buddy list through the Protocol Actions menu. You'll need
 211 to use a different client to register a new account if you don't have one
 212 yet.