annotate libfaim/README.gaim @ 637:8f0ba638d819

[gaim-migrate @ 647] highlighting should work better again committer: Tailor Script <[e-mail]>

Hello, your good friend EW here with a nice little notice that I'm sure will
affect the ten of you who actually read this.

I'm going to start trying to get gaim to use Oscar through libfaim. As far as I
can tell, the only thing it used to be able to do is sign on and receive IMs. I
updated libfaim to what's currently in the libfaim CVS on sourceforge. As of
right now, I've been able to implement most of the features libfaim offers.

I'm going to try to make as few modifications as possible to the libfaim code.
The only two modifications I'll probably ever make to it are 1) to make my life
easier or 2) to fix a compilation error. That means that what you're getting
when you enable oscar is basically faimtest (the very instructional program
included with the libfaim source on sourceforge) with the Gaim GTK front-end.
So far the changes to libfaim that I've made are:
- remove mkbuildinfo.sh and put the #defines it creates into Makefile.am
- fix a typo in aim.h - "aim_directim_initiate", not "aim_directim_intiate"

And finally, a word of warning. Gaim/Faim is VERY buggy. Please, don't use this
for anything other than laughs right now. Hopefully we'll get it working better
soon (please help!).

I think I'm ready to start dealing with bugs being reported against it now
though. If you're going to report a bug, please check first that a) you're using
the to-the-second absolute latest CVS version, b) it's not in the unsupported
features/known issues lists below, c) someone hasn't already reported the bug on
sourceforge (please check BOTH the open and closed bugs), and finally d) that
you can reproduce it.

Also, please *don't* IM me about a bug, as I have a tendency to forget things
like that. Reporting it on sourceforge is a much better way of reporting bugs,
because then other people can see that the bug is already known, and it's harder
for me to forget.

CURRENTLY SUPPORTED FEATURES
============================
Signing on
Receiving IMs
Sending IMs
Being idle
Being away/coming back
Setting your info
Getting users' info
Getting users' away messages
Telling the server who's on your permit/deny lists
Chat:
 - joining rooms
 - leaving rooms
 - talking
 - inviting someone
 - getting invited
 - refreshing the chatlist in the preferences dialog
ICQ!!! (Use your UIN instead of your SN to sign on)
Direct IM (aka IM Image, for sounds and pictures)

CURRENTLY UNSUPPORTED FEATURES
==============================
Warning users/getting warned
Chat:
 - whispering (this will never happen)
Getting/setting dir info
Changing your password
File Transfer (Get/Send)
Voice Chat
Buddy Icon

KNOWN ISSUES
============
- Oscar doesn't do whispering in chat rooms any more (and hasn't for quite a
while, evidently). So if you want to "whisper" to someone, just IM them.

- The permit list stuff is really warped. It works, but if you change it while
you're signed on, you'll probably get kicked off. Don't ask me why.

- "Allow anyone" and "Deny some" serve the same function. That's not a bug. But
"Allow anyone" works all the time (?) and "Deny some" doesn't work some of the
time. That's a bug.

- If you receive a message that's too large, gaim segfaults. I haven't watched
this in gdb or gotten a backtrace on it, so I'm not exactly sure what the
problem is. I think this actually happens on the TOC side of things too.

- Gaim/TOC can do some RVOUS actions, and Gaim/Faim can do others. This is not
because there is any difference in the protocols as far as the actual transfer
is concerned. The only difference is what has been implemented and what hasn't
been.

- What *is* protocol-dependent about the RVOUS stuff is that only Oscar can
request RVOUS actions, though both can receive them.

- Warnings and Dir Info are not in libfaim yet, and so are not in Gaim/Faim yet.

- There are also FIXME's scattered about gaim. Grep around for those, figure
out what needs to be fixed, do that sort of thing. :) (Fixing the things listed
in KNOWN ISSUES above, or any other bugs you happen to find, is a very good use
of your time.) (You didn't hear that from me.)