annotate libfaim/README.gaim @ 965:50f2977537d8

[gaim-migrate @ 975] segfault avoidance and notes about libfaim committer: Tailor Script <tailor@pidgin.im>
author Eric Warmenhoven <eric@warmenhoven.org>
date Tue, 10 Oct 2000 10:16:26 +0000
parents fa681641643d
children a57fbdc1a758
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
237
6ced2f1c8b24 [gaim-migrate @ 247]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
diff changeset
1 Hello, your good friend EW here with a nice little notice that I'm sure will
6ced2f1c8b24 [gaim-migrate @ 247]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
diff changeset
2 affect the ten of you who actually read this.
6ced2f1c8b24 [gaim-migrate @ 247]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
diff changeset
3
6ced2f1c8b24 [gaim-migrate @ 247]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
diff changeset
4 I'm going to start trying to get gaim to use Oscar through libfaim. As far as I
6ced2f1c8b24 [gaim-migrate @ 247]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
diff changeset
5 can tell, the only thing it used to be able to do is sign on and receive IMs. I
6ced2f1c8b24 [gaim-migrate @ 247]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
diff changeset
6 updated libfaim to what's currently in the libfaim CVS on sourceforge. As of
248
cfc73b8501a7 [gaim-migrate @ 258]
Eric Warmenhoven <eric@warmenhoven.org>
parents: 247
diff changeset
7 right now, I've been able to implement most of the features libfaim offers.
237
6ced2f1c8b24 [gaim-migrate @ 247]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
diff changeset
8
6ced2f1c8b24 [gaim-migrate @ 247]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
diff changeset
9 I'm going to try to make as few modifications as possible to the libfaim code.
6ced2f1c8b24 [gaim-migrate @ 247]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
diff changeset
10 The only two modifications I'll probably ever make to it are 1) to make my life
283
0f14e6d8a51b [gaim-migrate @ 293]
Eric Warmenhoven <eric@warmenhoven.org>
parents: 281
diff changeset
11 easier or 2) to fix a compilation error. That means that what you're getting
0f14e6d8a51b [gaim-migrate @ 293]
Eric Warmenhoven <eric@warmenhoven.org>
parents: 281
diff changeset
12 when you enable oscar is basically faimtest (the very instructional program
0f14e6d8a51b [gaim-migrate @ 293]
Eric Warmenhoven <eric@warmenhoven.org>
parents: 281
diff changeset
13 included with the libfaim source on sourceforge) with the Gaim GTK front-end.
519
926ba0807a2d [gaim-migrate @ 529]
Eric Warmenhoven <eric@warmenhoven.org>
parents: 503
diff changeset
14 So far the changes to libfaim that I've made are:
926ba0807a2d [gaim-migrate @ 529]
Eric Warmenhoven <eric@warmenhoven.org>
parents: 503
diff changeset
15 - remove mkbuildinfo.sh and put the #defines it creates into Makefile.am
932
13bdc97d433e [gaim-migrate @ 942]
Eric Warmenhoven <eric@warmenhoven.org>
parents: 931
diff changeset
16 - check for socklen_t for Solaris people (in aim_ft.c)
237
6ced2f1c8b24 [gaim-migrate @ 247]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
diff changeset
17
270
cfa39d39dec6 [gaim-migrate @ 280]
Eric Warmenhoven <eric@warmenhoven.org>
parents: 265
diff changeset
18 And finally, a word of warning. Gaim/Faim is VERY buggy. Please, don't use this
cfa39d39dec6 [gaim-migrate @ 280]
Eric Warmenhoven <eric@warmenhoven.org>
parents: 265
diff changeset
19 for anything other than laughs right now. Hopefully we'll get it working better
cfa39d39dec6 [gaim-migrate @ 280]
Eric Warmenhoven <eric@warmenhoven.org>
parents: 265
diff changeset
20 soon (please help!).
250
c5aa7bf99059 [gaim-migrate @ 260]
Eric Warmenhoven <eric@warmenhoven.org>
parents: 249
diff changeset
21
283
0f14e6d8a51b [gaim-migrate @ 293]
Eric Warmenhoven <eric@warmenhoven.org>
parents: 281
diff changeset
22 I think I'm ready to start dealing with bugs being reported against it now
0f14e6d8a51b [gaim-migrate @ 293]
Eric Warmenhoven <eric@warmenhoven.org>
parents: 281
diff changeset
23 though. If you're going to report a bug, please check first that a) you're using
0f14e6d8a51b [gaim-migrate @ 293]
Eric Warmenhoven <eric@warmenhoven.org>
parents: 281
diff changeset
24 the to-the-second absolute latest CVS version, b) it's not in the unsupported
0f14e6d8a51b [gaim-migrate @ 293]
Eric Warmenhoven <eric@warmenhoven.org>
parents: 281
diff changeset
25 features/known issues lists below, c) someone hasn't already reported the bug on
0f14e6d8a51b [gaim-migrate @ 293]
Eric Warmenhoven <eric@warmenhoven.org>
parents: 281
diff changeset
26 sourceforge (please check BOTH the open and closed bugs), and finally d) that
0f14e6d8a51b [gaim-migrate @ 293]
Eric Warmenhoven <eric@warmenhoven.org>
parents: 281
diff changeset
27 you can reproduce it.
0f14e6d8a51b [gaim-migrate @ 293]
Eric Warmenhoven <eric@warmenhoven.org>
parents: 281
diff changeset
28
0f14e6d8a51b [gaim-migrate @ 293]
Eric Warmenhoven <eric@warmenhoven.org>
parents: 281
diff changeset
29 Also, please *don't* IM me about a bug, as I have a tendency to forget things
0f14e6d8a51b [gaim-migrate @ 293]
Eric Warmenhoven <eric@warmenhoven.org>
parents: 281
diff changeset
30 like that. Reporting it on sourceforge is a much better way of reporting bugs,
0f14e6d8a51b [gaim-migrate @ 293]
Eric Warmenhoven <eric@warmenhoven.org>
parents: 281
diff changeset
31 because then other people can see that the bug is already known, and it's harder
0f14e6d8a51b [gaim-migrate @ 293]
Eric Warmenhoven <eric@warmenhoven.org>
parents: 281
diff changeset
32 for me to forget.
0f14e6d8a51b [gaim-migrate @ 293]
Eric Warmenhoven <eric@warmenhoven.org>
parents: 281
diff changeset
33
247
f6e8ea29b24f [gaim-migrate @ 257]
Eric Warmenhoven <eric@warmenhoven.org>
parents: 237
diff changeset
34 CURRENTLY SUPPORTED FEATURES
f6e8ea29b24f [gaim-migrate @ 257]
Eric Warmenhoven <eric@warmenhoven.org>
parents: 237
diff changeset
35 ============================
f6e8ea29b24f [gaim-migrate @ 257]
Eric Warmenhoven <eric@warmenhoven.org>
parents: 237
diff changeset
36 Signing on
258
1eeece1c7b7b [gaim-migrate @ 268]
Eric Warmenhoven <eric@warmenhoven.org>
parents: 256
diff changeset
37 Receiving IMs
247
f6e8ea29b24f [gaim-migrate @ 257]
Eric Warmenhoven <eric@warmenhoven.org>
parents: 237
diff changeset
38 Sending IMs
258
1eeece1c7b7b [gaim-migrate @ 268]
Eric Warmenhoven <eric@warmenhoven.org>
parents: 256
diff changeset
39 Being idle
247
f6e8ea29b24f [gaim-migrate @ 257]
Eric Warmenhoven <eric@warmenhoven.org>
parents: 237
diff changeset
40 Being away/coming back
f6e8ea29b24f [gaim-migrate @ 257]
Eric Warmenhoven <eric@warmenhoven.org>
parents: 237
diff changeset
41 Setting your info
249
810c595258c8 [gaim-migrate @ 259]
Eric Warmenhoven <eric@warmenhoven.org>
parents: 248
diff changeset
42 Getting users' info
519
926ba0807a2d [gaim-migrate @ 529]
Eric Warmenhoven <eric@warmenhoven.org>
parents: 503
diff changeset
43 Getting users' away messages
931
59d9e1177ab5 [gaim-migrate @ 941]
Eric Warmenhoven <eric@warmenhoven.org>
parents: 904
diff changeset
44 Setting your dir info
771
72e556f6b99d [gaim-migrate @ 781]
Eric Warmenhoven <eric@warmenhoven.org>
parents: 758
diff changeset
45 Warning users/getting warned
281
7b06ba09ffe2 [gaim-migrate @ 291]
Eric Warmenhoven <eric@warmenhoven.org>
parents: 280
diff changeset
46 Chat:
312
3069be4c291e [gaim-migrate @ 322]
Eric Warmenhoven <eric@warmenhoven.org>
parents: 302
diff changeset
47 - joining rooms
3069be4c291e [gaim-migrate @ 322]
Eric Warmenhoven <eric@warmenhoven.org>
parents: 302
diff changeset
48 - leaving rooms
3069be4c291e [gaim-migrate @ 322]
Eric Warmenhoven <eric@warmenhoven.org>
parents: 302
diff changeset
49 - talking
3069be4c291e [gaim-migrate @ 322]
Eric Warmenhoven <eric@warmenhoven.org>
parents: 302
diff changeset
50 - inviting someone
281
7b06ba09ffe2 [gaim-migrate @ 291]
Eric Warmenhoven <eric@warmenhoven.org>
parents: 280
diff changeset
51 - getting invited
904
e1a7fc4482b9 [gaim-migrate @ 914]
Eric Warmenhoven <eric@warmenhoven.org>
parents: 889
diff changeset
52 - creating rooms (needed to join empty rooms)
281
7b06ba09ffe2 [gaim-migrate @ 291]
Eric Warmenhoven <eric@warmenhoven.org>
parents: 280
diff changeset
53 - refreshing the chatlist in the preferences dialog
519
926ba0807a2d [gaim-migrate @ 529]
Eric Warmenhoven <eric@warmenhoven.org>
parents: 503
diff changeset
54 Direct IM (aka IM Image, for sounds and pictures)
280
e606585a38bd [gaim-migrate @ 290]
Eric Warmenhoven <eric@warmenhoven.org>
parents: 276
diff changeset
55
e606585a38bd [gaim-migrate @ 290]
Eric Warmenhoven <eric@warmenhoven.org>
parents: 276
diff changeset
56 CURRENTLY UNSUPPORTED FEATURES
e606585a38bd [gaim-migrate @ 290]
Eric Warmenhoven <eric@warmenhoven.org>
parents: 276
diff changeset
57 ==============================
707
668b4d544afe [gaim-migrate @ 717]
Eric Warmenhoven <eric@warmenhoven.org>
parents: 679
diff changeset
58 Telling the server who's on your permit/deny lists
258
1eeece1c7b7b [gaim-migrate @ 268]
Eric Warmenhoven <eric@warmenhoven.org>
parents: 256
diff changeset
59 Chat:
280
e606585a38bd [gaim-migrate @ 290]
Eric Warmenhoven <eric@warmenhoven.org>
parents: 276
diff changeset
60 - whispering (this will never happen)
931
59d9e1177ab5 [gaim-migrate @ 941]
Eric Warmenhoven <eric@warmenhoven.org>
parents: 904
diff changeset
61 Getting dir info
248
cfc73b8501a7 [gaim-migrate @ 258]
Eric Warmenhoven <eric@warmenhoven.org>
parents: 247
diff changeset
62 Changing your password
519
926ba0807a2d [gaim-migrate @ 529]
Eric Warmenhoven <eric@warmenhoven.org>
parents: 503
diff changeset
63 File Transfer (Get/Send)
926ba0807a2d [gaim-migrate @ 529]
Eric Warmenhoven <eric@warmenhoven.org>
parents: 503
diff changeset
64 Voice Chat
926ba0807a2d [gaim-migrate @ 529]
Eric Warmenhoven <eric@warmenhoven.org>
parents: 503
diff changeset
65 Buddy Icon
247
f6e8ea29b24f [gaim-migrate @ 257]
Eric Warmenhoven <eric@warmenhoven.org>
parents: 237
diff changeset
66
248
cfc73b8501a7 [gaim-migrate @ 258]
Eric Warmenhoven <eric@warmenhoven.org>
parents: 247
diff changeset
67 KNOWN ISSUES
cfc73b8501a7 [gaim-migrate @ 258]
Eric Warmenhoven <eric@warmenhoven.org>
parents: 247
diff changeset
68 ============
258
1eeece1c7b7b [gaim-migrate @ 268]
Eric Warmenhoven <eric@warmenhoven.org>
parents: 256
diff changeset
69 - Oscar doesn't do whispering in chat rooms any more (and hasn't for quite a
1eeece1c7b7b [gaim-migrate @ 268]
Eric Warmenhoven <eric@warmenhoven.org>
parents: 256
diff changeset
70 while, evidently). So if you want to "whisper" to someone, just IM them.
1eeece1c7b7b [gaim-migrate @ 268]
Eric Warmenhoven <eric@warmenhoven.org>
parents: 256
diff changeset
71
707
668b4d544afe [gaim-migrate @ 717]
Eric Warmenhoven <eric@warmenhoven.org>
parents: 679
diff changeset
72 - The permit/deny list stuff is really warped. I've commented it out; the code
668b4d544afe [gaim-migrate @ 717]
Eric Warmenhoven <eric@warmenhoven.org>
parents: 679
diff changeset
73 in libfaim is untested and it's causing way too many problems.
283
0f14e6d8a51b [gaim-migrate @ 293]
Eric Warmenhoven <eric@warmenhoven.org>
parents: 281
diff changeset
74
519
926ba0807a2d [gaim-migrate @ 529]
Eric Warmenhoven <eric@warmenhoven.org>
parents: 503
diff changeset
75 - Gaim/TOC can do some RVOUS actions, and Gaim/Faim can do others. This is not
926ba0807a2d [gaim-migrate @ 529]
Eric Warmenhoven <eric@warmenhoven.org>
parents: 503
diff changeset
76 because there is any difference in the protocols as far as the actual transfer
926ba0807a2d [gaim-migrate @ 529]
Eric Warmenhoven <eric@warmenhoven.org>
parents: 503
diff changeset
77 is concerned. The only difference is what has been implemented and what hasn't
926ba0807a2d [gaim-migrate @ 529]
Eric Warmenhoven <eric@warmenhoven.org>
parents: 503
diff changeset
78 been.
280
e606585a38bd [gaim-migrate @ 290]
Eric Warmenhoven <eric@warmenhoven.org>
parents: 276
diff changeset
79
e606585a38bd [gaim-migrate @ 290]
Eric Warmenhoven <eric@warmenhoven.org>
parents: 276
diff changeset
80 - What *is* protocol-dependent about the RVOUS stuff is that only Oscar can
519
926ba0807a2d [gaim-migrate @ 529]
Eric Warmenhoven <eric@warmenhoven.org>
parents: 503
diff changeset
81 request RVOUS actions, though both can receive them.
280
e606585a38bd [gaim-migrate @ 290]
Eric Warmenhoven <eric@warmenhoven.org>
parents: 276
diff changeset
82
960
fa681641643d [gaim-migrate @ 970]
Eric Warmenhoven <eric@warmenhoven.org>
parents: 933
diff changeset
83 - Direct IM has problems. Don't accept a Direct IM if you're offered one, it
fa681641643d [gaim-migrate @ 970]
Eric Warmenhoven <eric@warmenhoven.org>
parents: 933
diff changeset
84 may cause you to segfault.
fa681641643d [gaim-migrate @ 970]
Eric Warmenhoven <eric@warmenhoven.org>
parents: 933
diff changeset
85
933
07f056222d68 [gaim-migrate @ 943]
Eric Warmenhoven <eric@warmenhoven.org>
parents: 932
diff changeset
86 - Getting Dir Info is not in libfaim yet, and so is not in Gaim/Faim yet.
771
72e556f6b99d [gaim-migrate @ 781]
Eric Warmenhoven <eric@warmenhoven.org>
parents: 758
diff changeset
87
72e556f6b99d [gaim-migrate @ 781]
Eric Warmenhoven <eric@warmenhoven.org>
parents: 758
diff changeset
88 - Warnings are there now. Yes, I know it says the wrong value.
280
e606585a38bd [gaim-migrate @ 290]
Eric Warmenhoven <eric@warmenhoven.org>
parents: 276
diff changeset
89
965
50f2977537d8 [gaim-migrate @ 975]
Eric Warmenhoven <eric@warmenhoven.org>
parents: 960
diff changeset
90 - I have reason to believe that if a libfaim user invites a TOC user, the TOC
50f2977537d8 [gaim-migrate @ 975]
Eric Warmenhoven <eric@warmenhoven.org>
parents: 960
diff changeset
91 user will get a fucked up message. Receiving invitations work well, and sending
50f2977537d8 [gaim-migrate @ 975]
Eric Warmenhoven <eric@warmenhoven.org>
parents: 960
diff changeset
92 invitations to Oscar users works well.
50f2977537d8 [gaim-migrate @ 975]
Eric Warmenhoven <eric@warmenhoven.org>
parents: 960
diff changeset
93
370
5842aa11ab78 [gaim-migrate @ 380]
Eric Warmenhoven <eric@warmenhoven.org>
parents: 331
diff changeset
94 - There are also FIXME's scattered about gaim. Grep around for those, figure
250
c5aa7bf99059 [gaim-migrate @ 260]
Eric Warmenhoven <eric@warmenhoven.org>
parents: 249
diff changeset
95 out what needs to be fixed, do that sort of thing. :) (Fixing the things listed
c5aa7bf99059 [gaim-migrate @ 260]
Eric Warmenhoven <eric@warmenhoven.org>
parents: 249
diff changeset
96 in KNOWN ISSUES above, or any other bugs you happen to find, is a very good use
c5aa7bf99059 [gaim-migrate @ 260]
Eric Warmenhoven <eric@warmenhoven.org>
parents: 249
diff changeset
97 of your time.) (You didn't hear that from me.)