view libfaim/README @ 133:e277d5f0c1dd

[gaim-migrate @ 143] Let's see if I can remember everything I did: - Fixed a bug I let slip. If you choose the new option to not play login sounds when you log in, and then quit before the timeout is up, it would save that you didn't want login sounds at all. - Added two new plugin events: event_away and event_buddy_away. - Made GtkWidget *imaway in away.c and void play(uchar *, int) in sound.c not static any more (though not referenced in gaim.h). This is so plugins can use those (and not have to worry about writing their own sound code). - Wrote a quick plugin to auto-iconify windows when you go away. I had just been locally patching my own copy, since I figured it wasn't worth including as an option. It also demonstrates some of the issues of deciding between USE_APPLET and not. Perhaps plugins are the way to go with some things that would otherwise have been options (for example, the Lag-O-Meter is one of those things that could possibly have been a plugin instead of hard-coded in). I think that's everything. committer: Tailor Script <tailor@pidgin.im>
author Eric Warmenhoven <eric@warmenhoven.org>
date Wed, 19 Apr 2000 02:04:30 +0000
parents 68b230f8da5f
children 6ced2f1c8b24
line wrap: on
line source


libfaim pre-0.90 or so
----------------------

This is libfaim, the purpose of which is to implement as much as the
AOL AIM/OSCAR protocol as possible (which should be all of it).  After
nearly a year of development, its still nowhere close.  

This is not a full client and never will be.  libfaim only implements
the routines to implement a client (ie, there's no user interface).  

Status
------

I would not recommend using this version of libfaim in any form yet.  It's
beta-quality and I know it leaks memory quite badly.  It seems fairly
stable, however.  YMMV, YAYOR, etc.


Building
--------

Everything in this libfaim dist should build cleanly on any UNIX(-like)
operating system.  Originally developed on Linux+glibc.  Past versions 
known to work on Linux+libc5, FreeBSD, HP/UX, Solaris, Mac OS X Server,
and others.

libfaim builds as both libfaim.a and libfaim.so.  If your platform for
some reason does not support dynamic libraries (eg, you get errors when
building libfaim.so), you'll have to tweak the makefiles a bit to get
the utils/ directory to build.  

Otherwise, just do a 'make'.  I don't believe I use any specific features
GNU make, but if something fails, make sure you have it.  And bash too.


Accessories
-----------

In utils/, you'll find a few things extra:

  faimtest:   very rudimentary front-end.  no user interface, but does
              illustrate the basics of logging in and sending/recieving
              messages and buddy list notifications.  Potential front-
              end authors start here.

  aimpasswd:  utility to change an AIM password without using a full
              client.  Note that at the time of this writing, this
              didn't work quite right yet.  See the top of the code for
              latest status.

License
-------

libfaim is covered under my copyright under the terms of the Lesser GNU
Public License, as documented in the file COPYING in the top level directory.


Documentation
-------------

Unfortunatly, there is not currently any documentation on the libfaim API.
Use the source and utils/faimtest/faimtest.c as a reference when coding
front-ends.  


Contact Info
------------

The author (Adam Fritzler), can be reached at afritz@iname.com or mid@auk.cx.

I did have mailing lists available for faim-related discussion, but they
have dwindled and eventually broke and to my knowledge have yet to fix 
themselves.

Front-end information:
  http://www.auk.cx/faim/
Protocol information:
  http://www.auk.cx/faim/protocol/