head	1.38;
access;
symbols
	v2_0_0beta3:1.38
	v2_0_0beta2:1.38
	v2_0_0beta1:1.38
	v1_5_0:1.37
	v1_4_0:1.37
	gaim-doodle:1.38.0.2
	v1_3_1:1.37
	v1_3_0:1.37
	v1_2_1:1.37
	v1_2_0:1.37
	v1_1_4:1.37
	v1_1_3:1.37
	v1_1_2:1.37
	v1_1_1:1.37
	v1_1_0:1.37
	v1_0_3:1.37
	v1_0_2:1.37
	v1_0_1:1.37
	v1_0_0:1.37
	oldstatus:1.37.0.2
	v0_82:1.37
	v0_81:1.37
	v0_80:1.37
	v0_79:1.37
	v0_78:1.37
	v0_77:1.37
	v0_76:1.37
	v0_75:1.36
	v0_74:1.36
	v0_74-branch:1.36.0.2
	v0_73:1.36
	v0_72:1.33
	v0_71:1.33
	v0_70:1.33
	v0_69:1.33
	v0_68:1.32
	v0_67:1.32
	v0_65:1.32
	v0_64:1.30
	v0_63:1.30
	v0_62:1.30
	gaim_0_60:1.30
	v0_60:1.30
	ZERO_DOT_FUCKING_SIXTY:1.30
	v0_59_9:1.28.2.1
	v0_59_8:1.28.2.1
	gaim_0_59_7:1.28.2.1
	v0_60alpha3:1.29
	v0_59_6:1.28.2.1
	v0_59_5:1.28.2.1
	v0_59_4:1.28.2.1
	v0_59_3:1.28.2.1
	v0_59_2:1.28.2.1
	gtk1-stable:1.28.0.2
	v059:1.28
	v058:1.28
	v057:1.28
	v056:1.28
	v055:1.27
	v0_54:1.27;
locks; strict;
comment	@# @;


1.38
date	2005.01.06.23.11.12;	author thekingant;	state Exp;
branches;
next	1.37;

1.37
date	2004.02.01.01.49.08;	author robflynn;	state Exp;
branches;
next	1.36;

1.36
date	2003.11.16.15.08.14;	author lschiere;	state Exp;
branches;
next	1.35;

1.35
date	2003.11.16.14.08.56;	author lschiere;	state Exp;
branches;
next	1.34;

1.34
date	2003.11.16.06.00.53;	author lschiere;	state Exp;
branches;
next	1.33;

1.33
date	2003.09.09.14.35.07;	author lschiere;	state Exp;
branches;
next	1.32;

1.32
date	2003.06.05.22.26.07;	author chipx86;	state Exp;
branches;
next	1.31;

1.31
date	2003.06.03.15.36.07;	author lschiere;	state Exp;
branches;
next	1.30;

1.30
date	2002.11.28.02.41.30;	author seanegan;	state Exp;
branches;
next	1.29;

1.29
date	2002.10.27.17.12.26;	author lschiere;	state Exp;
branches;
next	1.28;

1.28
date	2002.03.30.10.22.29;	author warmenhoven;	state Exp;
branches
	1.28.2.1;
next	1.27;

1.27
date	2002.01.26.09.49.15;	author warmenhoven;	state Exp;
branches;
next	1.26;

1.26
date	2001.12.22.00.31.01;	author warmenhoven;	state Exp;
branches;
next	1.25;

1.25
date	2001.12.21.22.50.52;	author warmenhoven;	state Exp;
branches;
next	1.24;

1.24
date	2001.12.09.13.18.58;	author warmenhoven;	state Exp;
branches;
next	1.23;

1.23
date	2001.11.20.06.16.14;	author warmenhoven;	state Exp;
branches;
next	1.22;

1.22
date	2001.10.25.10.28.08;	author warmenhoven;	state Exp;
branches;
next	1.21;

1.21
date	2001.10.18.12.12.36;	author warmenhoven;	state Exp;
branches;
next	1.20;

1.20
date	2001.09.20.21.44.52;	author warmenhoven;	state Exp;
branches;
next	1.19;

1.19
date	2001.09.20.21.38.10;	author warmenhoven;	state Exp;
branches;
next	1.18;

1.18
date	2001.09.20.08.13.25;	author warmenhoven;	state Exp;
branches;
next	1.17;

1.17
date	2001.08.14.21.50.38;	author warmenhoven;	state Exp;
branches;
next	1.16;

1.16
date	2001.08.06.21.47.17;	author warmenhoven;	state Exp;
branches;
next	1.15;

1.15
date	2001.05.23.07.59.04;	author warmenhoven;	state Exp;
branches;
next	1.14;

1.14
date	2001.03.30.23.08.50;	author warmenhoven;	state Exp;
branches;
next	1.13;

1.13
date	2001.03.30.22.55.50;	author robflynn;	state Exp;
branches;
next	1.12;

1.12
date	2001.03.27.22.26.23;	author warmenhoven;	state Exp;
branches;
next	1.11;

1.11
date	2001.01.10.19.56.39;	author warmenhoven;	state Exp;
branches;
next	1.10;

1.10
date	2000.11.28.16.03.52;	author warmenhoven;	state Exp;
branches;
next	1.9;

1.9
date	2000.08.29.06.02.43;	author warmenhoven;	state Exp;
branches;
next	1.8;

1.8
date	2000.08.17.07.27.45;	author warmenhoven;	state Exp;
branches;
next	1.7;

1.7
date	2000.07.27.02.32.58;	author robflynn;	state Exp;
branches;
next	1.6;

1.6
date	2000.04.24.10.05.47;	author robflynn;	state Exp;
branches;
next	1.5;

1.5
date	2000.04.19.02.48.47;	author warmenhoven;	state Exp;
branches;
next	1.4;

1.4
date	2000.03.31.20.20.34;	author warmenhoven;	state Exp;
branches;
next	1.3;

1.3
date	2000.03.25.22.28.17;	author warmenhoven;	state Exp;
branches;
next	1.2;

1.2
date	2000.03.25.17.12.05;	author warmenhoven;	state Exp;
branches;
next	1.1;

1.1
date	2000.03.23.03.09.51;	author robflynn;	state Exp;
branches;
next	;

1.28.2.1
date	2002.08.26.01.05.21;	author seanegan;	state Exp;
branches;
next	;


desc
@@


1.38
log
@This should close that new jabber bug that guy just added.

Also, we should sync this document with the protocols web page and
keep one or the other.  I wouldn't mind removing this and the FAQ
from CVS and telling people to look at the web page...
@
text
@gaim
========================
Rob Flynn <gaim@@robflynn.com> IM: RobFlynn (current maintainer)
Syd Logan - Super Hacker and Resident Designated Driver
Jim Duchek <jimduchek@@ou.edu> IM: Zilding (former maintainer)
Eric Warmenhoven <eric@@warmenhoven.org> (retired)
Mark Spencer <markster@@marko.net>

Gaim is an IM client that supports many protocols, including AIM, ICQ,
MSN, IRC, and Jabber. Gaim is NOT endorsed by, nor affiliated with,
AOL nor any other company in ANY way.


BUILD
=====

Read the 'INSTALL' file for more detailed directions.

Gaim uses the standard ./configure ; make. You need to use gmake, BSD
make probably won't work. Remember, run ./configure --help to see what
build options are available.

In order to compile Gaim, you need to have GTK+ 2.0 installed (as
well as the development files!). The configure script will fail if you
don't. You can get it from http://www.gtk.org/.

For sound support, you also need libao
(http://freshmeat.net/projects/libao/) and libaudiofile
(http://www.68k.org/~michael/audiofile/). For spellchecking support, you
need libgtkspell (http://gtkspell.sf.net/). Your distro of choice
probably already includes these, just be sure to install the development
packages.

RUN
===

You should run 'make install' as root to make sure plugins and other files
get installed into locations they want to be in. Once you've done that,
you only need to run 'gaim'.

Protocol plugins (prpls) are now automatically loaded. Simply go to the
account editor, add a new account, and all supported protocols will be
there. Be sure to use OSCAR (AIM/ICQ) and not the old TOC or ICQ plugins.

Read below for protocol-specific information.


PLUGINS
=======

If you do not wish to enable the plugin support within Gaim, run the
./configure script with the --disable-plugins option and recompile your
source code.  This will prevent the ability to load plugins.

'make install' puts the plugins in $PREFIX/lib/gaim (PREFIX being what
you specified when you ./configure'd - it defaults to /usr/local). Gaim
looks for the plugins in that directory by default, but they do not have
to be there to use them. Also, plugins have a .so extension by default,
though they do not have to.

To build a plugin from a .c file, put it in the plugins/ directory in
the source and run 'make filename.so', e.g. if you have the .c file
'kickass.c', put it in the plugins/ directory, and from that directory,
run 'make kickass.so'.


NOTES
=====

If you manually set a command for your browser or sound player options,
make sure to put double-quotes around the "%s", otherwise bad things may
happen.

If you come across a bug, please report it to http://gaim.sf.net/bug.php.

See README.CVS for information on the bleeding edge CVS version of Gaim.
You probably shouldn't use it, as it may eat your children, as well as
your settings.


PROTOCOL INFORMATION
====================

Each protocol is hacked by both Rob and Eric, though there is one person
that kind of "owns" a protocol (mostly indicating that they were the
person that originally wrote it). Their name will be next to the protocol;
they're the people to complain to when something doesn't work ;).


TOC (Mark)
===

You shouldn't use TOC, you should use Oscar instead. TOC can sync your
buddy list with the server (if it's not too long), and can respond to file
transfer requests (both sending and receiving). Other than that, there's
nothing it can do that Oscar can't, yet. The TOC protocol doesn't allow
retrieval of away messages; isn't capable of sending or receiving buddy
icons; it also can't make file transfer requests.


Oscar (Mark)
=====

Oscar is the default protocol. It is recommended that you use Oscar for
both AIM and ICQ, as TOC isn't very featureful and the old ICQ protocol no
longer works. 

For AIM, Oscar can get people's away messages. It can request and accept
Direct Connections, and has limited support for file transfer. IM Image 
does not currently work. It can send and receive buddy icons if you have 
GdkPixbuf.

For ICQ, it supports nearly everything that the old ICQ plugin supported,
which isn't much. To use Oscar for ICQ, enter your ICQ UIN as the
screenname. The default host/port will work. You'll need to use a different
client to register a new ICQ account if you don't have one yet.


Yahoo (Sean)
=====

Yahoo is currently using the new YMSG protocol that newer official Yahoo
clients are using. This protocol is much better than the old one, and
tends to be somewhat more reliable. However, the Yahoo service is still
flaky at best. 


IRC (Ethan)
===

There are three ways to join an IRC chat room. The first is the File->Join
A Chat menu option in the Buddy List window. The second is the "Chat"
button at the bottom of the buddy list. The third is to type "/join #name"
in an IM window where the "Send Message As" menu is set to your IRC
account. There are other / commands that work in IM and Chat windows for
IRC, /help will give you a list of them.


MSN (Christian)
===

With MSN you can join a conversation with several people, but you can't
invite people from the IM window yet.


ICQ (Mark)
===

The ICQ plugin is deprecated and will probably be removed soon. The
protocol only marginally works. You should use Oscar for ICQ. You'll
need a different client to register an ICQ account if you don't have
one yet.


Jabber (Nathan)
======

Transports aren't currently supported at all, though if you have a
transport already subscribed Gaim will use it (you can't add or remove
transports though). In order to use a server other than jabber.org, set
your username to include the server, e.g. warmenhoven@@mycompany.com. This
is the actual format of the Jabber ID anyway; Jabber is email with online
notification. You can register a new Jabber account by checking the
appropriate box in the account editor for your Jabber account.


Napster (Mark)
=======

Heh.  Ok, so I (Rob) am on crack!  Gaim can sign on/off of Napster,
add/remove people to your hotlist (buddylist) as well as chat privately
and in chat rooms.  You can search for files and browse a list of other
user's files.  You can currently download files as long as the person
you're retrieving files from is not firewalled.


Zephyr (Sean)
======

Let me start off by saying how much I really despise Zephyr. They do a
lot of things that make me realize why this never caught on. For those
of you who are unfortunate enough to feel compelling need to use this,
gaim now has a Zephyr plugin. It can currently sign on/off, handles
presence/buddy lists (it even imports your .anyone file!), and can
send/receive personal messages. A lot of stuff is missing, this is just
a real rough first stab at it.


Gadu-Gadu (Sean)
=========

I really shouldn't be taking credit for Gadu-Gadu, I'm just the person who
commits the patches that Arkadiusz Miskiewicz gives me. Gadu-Gadu is an IM
system most similar to ICQ that is quite popular in Poland. It can manage
your server-side buddy list through the Protocol Actions menu. You'll need
to use a different client to register a new account if you don't have one
yet.
@


1.37
log
@New e-mail address for me
@
text
@d90 1
a90 1
TOC (Rob)
d146 1
a146 1
ICQ (Eric)
d163 2
a164 2
notification. You'll need to use a different client to register a Jabber
account if you don't have one yet.
d167 1
a167 1
Napster (Rob)
d177 1
a177 1
Zephyr (Eric)
d189 1
a189 1
Gadu-Gadu (Eric)
a197 1

@


1.36
log
@*sigh* at least this one isn't my fault
@
text
@d3 1
a3 1
Rob Flynn <rob@@marko.net> IM: RobFlynn (current maintainer)
@


1.35
log
@i'm surprised i only got one report of this, and not from the usual
suspects
@
text
@d3 1
a3 1
Rob Flynn <rob@@marko.net> IM: RobFlynn (currnet maintainer)
@


1.34
log
@didn't notice my commits weren't happening, now i did, but you all miss out
on having on-topic commit log this time around
@
text
@d41 1
a41 1
Protocol plugins (prpls) are now automaticly loaded. Simply go to the
@


1.33
log
@Okay, our text files are REALLY OLD. they need massively updated, HACKING
especially is like 2/3rds wrong. but there is more wrong than i care to
deal with right now. over the next few days you will hopefully see some
updates, BUT IT WON'T BE ENOUGH. someone had better decide to help out
:-)
@
text
@d41 1
a41 1
Protocol plugins (prpls) are now automaticly loaded. Simply to go the
@


1.32
log
@<mstyne> #commits is like watching golf
<mstyne> golf... on pause.
@
text
@d101 1
a101 1
Oscar (Eric)
d106 1
a106 1
longer works.
d109 2
a110 2
Direct IM connections, but it cannot yet transfer files through this (or
through any other means). It can send and receive buddy icons if you have
d119 1
a119 1
Yahoo (Eric)
d125 1
a125 1
flaky at best. Group chats aren't supported yet.
d128 1
a128 1
IRC (Eric)
d139 1
a139 1
MSN (Eric)
d155 1
a155 1
Jabber (Eric)
@


1.31
log
@ Tim Ringenbach updated the readme some
@
text
@d198 1
@


1.30
log
@There, ZuperDee.
@
text
@d27 6
a32 9
Gaim will try to compile with Gnome features if you have Gnome on your
system. If you don't have them, it will settle for simply GTK. If you
don't want Gnome bits, ./configure --disable-gnome

If you want to build as a GNOME applet:
./configure --enable-panel ; make
then su to root and run "make install".
Afterwards panel->Add applet->Network->Gaim should be there.

d41 3
a43 9
To use the other services (such as Yahoo and IRC) which are available
as plugins:

They are installed in $libdir/gaim, which usually is either /usr/lib/gaim
or /usr/local/lib/gaim, and should have a somewhat descriptive name (e.g.
libyahoo.so or libirc.so). Load those plugins using the normal plugin
dialog.  Then in the account editor, add a new account; the Protocol option
menu should now have another option for the protocol that you loaded. Then
you can sign that account on.
d76 3
a78 9
There always seems to be some iffy-ness by a lot of people about
whether to use the CVS version or stick with a stable release. Use the
CVS version. If you need a version that you know is reliable, then keep
your favorite one in case of an emergency. But for the most part, gaim
is not mission-critical software, and if you can help us find a few bugs
before we release, all the better. (Also, CVS tends to be more stable
than releases, since we get 10 or 12 bug reports right after we make a
release, and all those bugs are fixed within a day or two usually.) Read
http://gaim.sf.net/cvs.php for more information.
@


1.29
log
@change references to bug.php3 to bug.php (thanks David D. Kilzer)
@
text
@d23 1
a23 1
In order to compile Gaim, you need to have GTK+ 1.2.5 installed (as
@


1.28
log
@"God I'm stoned." -- "Kermit the Frog"
"God I'm drunk." -- Eric Warmenhoven
@
text
@d83 1
a83 1
If you come across a bug, please report it to http://gaim.sf.net/bug.php3.
@


1.28.2.1
log
@:)
@
text
@a12 6
0.59.x
======
This version of Gaim is a stable branch.  These releases are bugfix 
releases for GTK+ 1.2.  Development will continue on our main branch
in GTK+ 2 only.

@


1.27
log
@so long, and thanks for all the fish
@
text
@d6 1
a6 1
Eric Warmenhoven <warmenhoven@@yahoo.com> (retired)
@


1.26
log
@eh
@
text
@a3 1
Eric Warmenhoven <warmenhoven@@yahoo.com> IM: EWarmenhoven (lead devel)
d6 1
@


1.25
log
@hi.
@
text
@d49 3
a51 3
libyahoo.so or irc.so). Load those plugins using the normal plugin dialog.
Then in the account editor, add a new account; the Protocol option menu
should now have another option for the protocol that you loaded. Then
@


1.24
log
@i'm not like them, but i can pretend.
@
text
@d130 2
a131 1
screenname. The default host/port will work.
d165 3
a167 1
protocol only marginally works. You should use Oscar for ICQ.
d178 2
a179 1
notification.
d210 3
a212 1
your server-side buddy list through the Protocol Actions menu.
@


1.23
log
@that's just rather pathetic
@
text
@d10 2
a11 2
MSN, IRC, and Jabber. Gaim is NOT endorsed by, nor affiliated with, AOL
nor any other company in ANY way.
a12 1
* Build:
d14 2
a15 3
./configure ; make 
for the stock version.  ./configure --help to see what option you can get.
You need to use gmake, BSD make will not work.
d17 9
a25 2
You need GTK 1.2.3.  I don't wanna hear about it, if you can't get it to
work under a lower version.
d33 1
a33 1
then su to root and run "make install". 
a35 1
* Run:
d37 9
a45 1
type "./gaim"
a46 2
To use the other services (such as Yahoo and IRC) which are available as
plugins:
d51 4
a54 2
should now have another option for the protocol that you loaded. Then you
can sign that account on.
a55 4
ICQ and Zephyr are currently the only two protocols that don't use the
global proxy configuration; however, if you have the proxy set to use a
SOCKS5 proxy, ICQ will use it. If the proxy options aren't robust enough
for you there are several libraries that you can link gaim against.
d57 2
a58 1
* Plugins:
d64 143
a206 32
'make install' puts the plugins in $PREFIX/lib/gaim (PREFIX being what you
specified when you ./configure'd - it defaults to /usr/local). Gaim looks
for the plugins in that directory by default, but they do not have to be
there to use them. Also, plugins have a .so extension by default, though
they do not have to.

* Notes:

This should now compile under Solaris, Digital Unix, Irix, etc w/o a
problem.

This compiles without warnings on Linux-x86 2.2.10 glibc2.1, GTK 1.2.3 system.
If you get warnings on something else, let me know and I'll check it out.
If you get errors, upgrade to the latest GTK-1.2 before bothering me.

The resulting executable is standalone, so you can put it in /usr/bin or
whatever.

The panel (if you made an applet) requires certain things to be in certain
places, but the Makefile/configure script should figure things out for you.

If you set a command for your browser or your sound player, make sure to put
quotes around the %s where appropriate; otherwise, bad things could happen.
Remember, you did it to yourself.

Send me bug reports.  The web page is http://gaim.sourceforge.net/and the ftp
site is ftp://ftp.sourceforge.net/pub/sourceforge/gaim. We also have a
sourceforge page at http://sourceforge.net/projects/gaim/

Keep your eyes out for updates, and I'll try to keep the program maintained.
Other contributors and patches are welcomed.  Please read the FAQ first. You
can come ask questions in #gaim on irc.openprojects.net.
@


1.22
log
@i'm making an effort
@
text
@d76 4
@


1.21
log
@I got an itty bitty diff for you now ;-)
@
text
@d9 4
@


1.20
log
@this is just a test. really.
@
text
@d47 1
a47 1
If you do not wish to enable the plugin support within GAIM, run the
@


1.19
log
@this is mostly just a test
@
text
@d4 1
a4 1
Eric Warmenhoven <warmenhoven@@yahoo.com> IM: EWarmenhoven (Gnome Boy :))
@


1.18
log
@documentation updates.
@
text
@d77 2
a78 1
Other contributors and patches are welcomed.  Please read the FAQ first.
@


1.17
log
@I'm EWarmenhoven.
@
text
@d9 1
a9 1
Build:
d27 1
a27 1
Run:
d45 13
a57 1
Notes:
a77 1

@


1.16
log
@i'm EricWarmenhoven. other misc. things.
@
text
@d4 1
a4 1
Eric Warmenhoven <warmenhoven@@yahoo.com> IM: EricWarmenhoven (Gnome Boy :))
@


1.15
log
@C:)
@
text
@d4 1
a4 1
Eric Warmenhoven <warmenhoven@@yahoo.com> IM: EWarmenhoven (Gnome Boy :))
@


1.14
log
@if you want
to destroy
my sweater

pull this thread
as i walk
away

watch me unravel
i'll soon
be naked

lying on the floor
i've come
undone
@
text
@d22 5
d40 4
a43 4
If you want to build as a GNOME applet:
./configure --enable-panel ; make
then su to root and run "make install". 
Afterwards panel->Add applet->Network->Gaim should be there.
d61 2
a62 2
site is ftp://ftp.marko.net/pub/gaim. We also have a sourceforge page at
http://sourceforge.net/projects/gaim/
@


1.13
log
@Screw it...
@
text
@d13 1
@


1.12
log
@the website is now gaim.sourceforge.net
@
text
@d3 1
a3 1
Rob Flynn <rflynn@@blueridge.net> IM: RobFlynn (currnet maintainer)
@


1.11
log
@README now has docs on how to use Yahoo/IRC/etc, so people aren't so lost.
Yahoo can now receive messages and linkify them properly
doesn't say "quit" in applet login window
@
text
@d54 1
a54 1
Send me bug reports.  The web page is http://www.marko.net/gaim and the ftp
@


1.10
log
@small changes to README. oscar's getfile is getting there; it works but the sending is blocking so that's not a good thing.
@
text
@d25 9
@


1.9
log
@arf
@
text
@a43 1
Make sure to enable GNOME sounds if you want gaim sounds for the applet.
@


1.8
log
@just some doc updates
@
text
@d47 2
a48 1
site is ftp://ftp.marko.net/pub/gaim
@


1.7
log
@Changed around some email addresses for myself, etc.
@
text
@d17 4
d26 1
a26 1
./configure --enable-gnome ; make
d34 1
@


1.6
log
@Gotta give credit where credit is due.
@
text
@d3 1
a3 1
Rob Flynn <rob@@linuxpimps.com> IM: RobFlynn (currnet maintainer)
@


1.5
log
@Took Sam Black's suggestion of saying that GNOME sounds need to be enabled
for the applet sounds to work.
@
text
@d4 2
@


1.4
log
@Touch-ups with the install for applet. Rather than all that extra stuff at
the end of ./configure, all you need now is --enable-gnome. ./configure will
figure out where gnome-config is and use that to determine where things should
be installed.
@
text
@d37 1
@


1.3
log
@Various little touch-ups
@
text
@d36 1
a36 3
places, I recommend running:
./configure --enable-gnome --sysconfdir=`gnome-config --sysconfdir` \
--datadir=`gnome-config --datadir`
@


1.2
log
@More panel adjustments and useful information
@
text
@d36 3
a38 2
places, I recommend adding the options --sysconfdir=/etc --datadir=/usr/share
to ./configure --enable-gnome
@


1.1
log
@Commit of some files
@
text
@d19 4
a22 2
If you built as a GNOME applet, su to root and run "make install". 
Afterwards panel->add applet->Amusements->Gaim should be there.
d34 4
@

